younifyd
Menu

Get Campaign Groups

List campaign access groups

GET/v1/campaign_groups

Use it in a workflow

  1. Add a step and choose the Talon.One connector.
  2. Pick the Get Campaign Groups action (under management).
  3. Fill in the fields below, then reference the result from later steps as {{getCampaignGroups.response.data}}.

Request

Query parameters

pageSizeinteger (int64)

The number of items in the response.

Default 1000

skipinteger (int64)

The number of items to skip when paging through large result sets.

sortstring

The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with `-`. **Note:** You may not be able to use all fields for sorting. This is due to performance limitations.

Response

Returns 200 with an object. Read it in later steps with {{getCampaignGroups.response.data.<field>}}.

totalResultSizeinteger (int64)
dataarray<object>
idinteger (int64)required

The internal ID of this entity.

createdstring (date-time)required

The time this entity was created.

modifiedstring (date-time)required

The time this entity was last modified.

accountIdinteger (int64)required

The ID of the account that owns this entity.

namestringrequired

The name of the campaign access group.

descriptionstring

A longer description of the campaign access group.

subscribedApplicationsIdsarray<integer (int64)>

A list of IDs of the Applications that this campaign access group is enabled for.

campaignIdsarray<integer (int64)>

A list of IDs of the campaigns that are part of the campaign access group.

json
{
  "totalResultSize": 1,
  "data": [
    {
      "accountId": 3886,
      "created": {},
      "name": "Europe access group",
      "subscribedApplicationsIds": [
        1,
        2,
        3
      ],
      "modified": {},
      "description": "A group that gives access to all the campaigns for the Europe market.",
      "id": 6,
      "campaignIds": [
        4,
        6,
        8
      ]
    }
  ]
}

Need more? See the Talon.One guide for connection setup and behaviour shared by every action.