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.

start_datestring

The date when campaign started.

end_datestringnullable

The date when campaign ended. Null if the campaign in ongoing.

objectiveenum

The objective of the campaign.

One ofimpressions, clicks, or other.
statusenum

The status of the campaign.

One ofactive, inactive, or deleted.
total_clicksnumber

The number of total clicks for the campaign.

total_impressionsnumber

The number of total impressions for the campaign.

total_spendnumber

The total budget for the campaign.

currency_codestringnullable

The ISO 4217 currency code of 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.

last_synced_atstring

The ISO 8601 timestamp when the campaign was last synced by Rutter.

platform_dataobjectOptional

The raw platform data corresponding to the Rutter object.

Endpoints
GET
/ads/campaigns
GET
/ads/campaigns/:id
GET
/ads/campaigns/dailies

List Campaigns

GEThttps://production.rutterapi.com/versioned/ads/campaigns

Request Parameters

    access_tokenstringqueryRequired

    The access token of the connection.

    cursorstringqueryOptional

    Used to paginate to the next batch of objects. Should be a copy of the next_cursor value from the previous response.

    limitintegerqueryOptional

    Used to limit the number of returned objects. Defaults to 50.

    sortstringqueryOptional

    Used to sort the response objects, e.g. last_synced_at ASC. If a value is provided but ASC or DESC is not, defaults to ASC. If omitted, defaults to updated_at DESC. Currently supports the updated_at and last_synced_at fields.

    expandenumqueryOptional

    Include platform specific data (includes additional fields not provided by the Rutter object).

    Must beplatform_data.
    last_synced_at_minintegerqueryOptional

    Used to filter objects with a last_synced_at value greater than or equal to the supplied value. Should be a Unix time in milliseconds.

    updated_at_maxintegerqueryOptional

    Used to filter objects with a updated_at value less than or equal to the supplied value. Should be a Unix time in milliseconds.

    updated_at_minintegerqueryOptional

    Used to filter objects with a updated_at value greater than or equal to the supplied value. Should be a Unix time in milliseconds.

    force_fetchenumqueryOptional

    Used to force a response even if the underlying connection has not finished its initial sync.

    One oftrue or false.

Response Body

Fetch a Campaign

GEThttps://production.rutterapi.com/versioned/ads/campaigns/:id

Request Parameters

    idstringpathRequired

    The unique ID of the object.

    access_tokenstringqueryRequired

    The access token of the connection.

    id_typeenumqueryOptional

    Used to indicate the type of id that is supplied. Defaults to rutter. Not currently supported on Sage Intacct or Sage Business Cloud.

    One ofrutter or platform.
    force_fetchenumqueryOptional

    Used to force a response even if the underlying connection has not finished its initial sync.

    One oftrue or false.

Response Body

List Dailies for a Campaign

GEThttps://production.rutterapi.com/versioned/ads/campaigns/dailies

This endpoint returns a list of the summary of the campaign's cost and performance broken down by day. Note: all data is refreshed every incremental sync.

Request Parameters

    idstringqueryRequired

    The Rutter ID of the campaign object.

    access_tokenstringqueryRequired

    The access token of the connection.

    cursorstringqueryOptional

    Used to paginate to the next batch of objects. Should be a copy of the next_cursor value from the previous response.

    limitintegerqueryOptional

    Used to limit the number of returned objects. Defaults to 50.

    sortstringqueryOptional

    Used to sort the response objects, e.g. last_synced_at ASC. If a value is provided but ASC or DESC is not, defaults to ASC. If omitted, defaults to updated_at DESC. Currently supports the updated_at and last_synced_at fields.

    expandenumqueryOptional

    Include platform specific data (includes additional fields not provided by the Rutter object).

    Must beplatform_data.
    last_synced_at_minintegerqueryOptional

    Used to filter objects with a last_synced_at value greater than or equal to the supplied value. Should be a Unix time in milliseconds.

    updated_at_maxintegerqueryOptional

    Used to filter objects with a updated_at value less than or equal to the supplied value. Should be a Unix time in milliseconds.

    updated_at_minintegerqueryOptional

    Used to filter objects with a updated_at value greater than or equal to the supplied value. Should be a Unix time in milliseconds.

    force_fetchenumqueryOptional

    Used to force a response even if the underlying connection has not finished its initial sync.

    One oftrue or false.

Response Body

Have questions?

Contact support for personalized guidance.

Contact support
Previous
Ad Accounts