Ads

Campaigns

The Campaign object

Properties

idstring

The Rutter generated unique ID of the campaign.

platform_idstring

The platform specific ID of the campaign.

account_idstringnullable

The Rutter ID of the Ad Account linked to the campaign.

objectiveenum

The objective of the campaign.

One ofimpressionsclicks, or other.
statusenum

The status of the campaign.

One ofactiveinactive, or deleted.
budgetnumbernullable

The remaining budget for the campaign.

clicksnumbernullable

The number of clicks for the campaign.

currency_codestringnullable

The ISO 4217 currency code of the campaign.

impressionsnumbernullable

The number of impressions for the campaign.

namestringnullable

The name of the campaign.

total_budgetnumbernullable

The total budget for the campaign.

created_atstringnullable

The ISO 8601 timestamp that the campaign was created.

updated_atstringnullable

The ISO 8601 timestamp that the campaign was last updated.

platform_dataobjectoptional

The raw platform data corresponding to the Rutter object.

Show platform_data attributes
Example Campaign Object
{
  "id": "00000000-0000-0000-0000-000000000000",
  "platform_id": "12345678",
  "account_id": "00000000-0000-0000-0000-000000000000",
  "objective": "clicks",
  "status": "active",
  "budget": 98.76,
  "clicks": 10,
  "currency_code": "USD",
  "impressions": 1000,
  "name": "Ads Campaign",
  "total_budget": 99.99,
  "created_at": "2023-01-02T02:34:56.000Z",
  "updated_at": "2023-01-02T02:34:56.000Z",
  "platform_data": {
    "id": 123,
    "data": "Varies by platform"
  }
}

List Campaigns

GET /versioned/ads/campaigns
Supported for: FacebookGoogleTiktok

Request Parameters

    access_tokenstringquery

    The access token of the connection.

    cursorstringoptionalquery

    The cursor to use for pagination. This value is passed in from next_cursor field in a previous request.

    expandenumoptionalquery

    Used to request inclusion of optional objects.

    Can beplatform_data.
    force_fetchenumoptionalquery

    Force a response even if the underlying connection hasn't finished the initial sync.

    One oftrue or false.
    last_synced_at_minintegeroptionalquery

    Unix Timestamp in milliseconds representing the minimum last_synced_at datetime to fetch entities from.

    limitintegeroptionalquery

    The limit on the number of entities returned.

    sortstringoptionalquery

    The field and direction to sort by (ASC or DESC), e.g. last_synced_at ASC. Currently supports the fields: updated_at, last_synced_at. If a field is provided but ASC or DESC is not, defaults to ASC. If this field is omitted, defaults, to updated_at DESC.

    updated_at_maxintegeroptionalquery

    Unix Timestamp in milliseconds representing the maximum updated_at datetime to fetch entities from.

    updated_at_minintegeroptionalquery

    Unix Timestamp in milliseconds representing the minimum updated_at datetime to fetch entities from.

Response Body

    campaignsarray
    Show campaigns attributes
    next_cursorstringnullableoptional
Example Response Body
{
  "campaigns": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "platform_id": "12345678",
      "account_id": "00000000-0000-0000-0000-000000000000",
      "objective": "clicks",
      "status": "active",
      "budget": 98.76,
      "clicks": 10,
      "currency_code": "USD",
      "impressions": 1000,
      "name": "Ads Campaign",
      "total_budget": 99.99,
      "created_at": "2023-01-02T02:34:56.000Z",
      "updated_at": "2023-01-02T02:34:56.000Z",
      "platform_data": {
        "id": 123,
        "data": "Varies by platform"
      }
    }
  ],
  "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
}

Fetch a Campaign

GET /versioned/ads/campaigns/:id

Endpoint Not Available for Version 2023-03-14

The endpoint Fetch a Campaign (GET/ads/campaigns/:id) is not available in version 2023-03-14. The endpoint may be available in a prior or later version. To see API version history, please visit the changelog page.