Campaigns
The Campaign Object
Properties
id
stringThe Rutter generated unique ID of the campaign.
platform_id
stringThe platform specific ID of the campaign.
account_id
stringnullableThe Rutter ID of the Ad Account linked to the campaign.
start_date
stringThe date when campaign started.
end_date
stringnullableThe date when campaign ended. Null if the campaign in ongoing.
objective
enumThe objective of the campaign.
status
enumThe status of the campaign.
total_clicks
numberThe number of total clicks for the campaign.
total_impressions
numberThe number of total impressions for the campaign.
total_spend
numberThe total budget for the campaign.
currency_code
stringnullableThe ISO 4217 currency code of the campaign.
name
stringnullableThe name of the campaign.
total_budget
numbernullableThe total budget for the campaign.
created_at
stringnullableThe ISO 8601 timestamp that the campaign was created.
updated_at
stringnullableThe ISO 8601 timestamp that the campaign was last updated.
last_synced_at
stringThe ISO 8601 timestamp when the campaign was last synced by Rutter.
platform_data
objectOptionalThe raw platform data corresponding to the Rutter object.
List Campaigns
Request Parameters
access_token
stringqueryRequiredThe access token of the connection.
cursor
stringqueryOptionalUsed to paginate to the next batch of objects. Should be a copy of the next_cursor
value from the previous response.
limit
integerqueryOptionalUsed to limit the number of returned objects. Defaults to 50.
sort
stringqueryOptionalUsed 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.
Sortable fields:
expand
enumqueryOptionalInclude platform specific data (includes additional fields not provided by the Rutter object).
last_synced_at_min
integerqueryOptionalUsed 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_max
integerqueryOptionalUsed 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_min
integerqueryOptionalUsed to filter objects with a updated_at
value greater than or equal to the supplied value. Should be a Unix time in milliseconds.
force_fetch
enumqueryOptionalUsed to force a response even if the underlying connection has not finished its initial sync.
Response Body
- TikTok
Fetch a Campaign
Request Parameters
id
stringpathRequiredThe unique ID of the object.
access_token
stringqueryRequiredThe access token of the connection.
id_type
enumqueryOptionalUsed to indicate the type of id
that is supplied. Defaults to rutter
. Not yet supported on Sage Intacct or Dynamics 365 Business Central.
force_fetch
enumqueryOptionalUsed to force a response even if the underlying connection has not finished its initial sync.
Response Body
- TikTok
List Dailies for a Campaign
This endpoint returns a list of the summary of the campaign's cost and performance broken down by day.
Request Parameters
id
stringqueryRequiredThe Rutter ID of the campaign object.
access_token
stringqueryRequiredThe access token of the connection.
cursor
stringqueryOptionalUsed to paginate to the next batch of objects. Should be a copy of the next_cursor
value from the previous response.
limit
integerqueryOptionalUsed to limit the number of returned objects. Defaults to 50.
sort
stringqueryOptionalUsed 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.
Sortable fields:
expand
enumqueryOptionalInclude platform specific data (includes additional fields not provided by the Rutter object).
last_synced_at_min
integerqueryOptionalUsed 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_max
integerqueryOptionalUsed 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_min
integerqueryOptionalUsed to filter objects with a updated_at
value greater than or equal to the supplied value. Should be a Unix time in milliseconds.
force_fetch
enumqueryOptionalUsed to force a response even if the underlying connection has not finished its initial sync.
Response Body
- TikTok
Have questions?
Contact support for personalized guidance.