List Campaigns
/unified/ads/campaigns
Query Parameters
Refer Specifying query parameters in Truto APIs
The unique identifier for the account.
3 supported3 required
The start time for the campaign.
2 supported
1 supported
Show Truto-specific parameters
The ID of the integrated account to use for the request.
62f44730-dd91-461e-bd6a-aedd9e0ad79dThe format of the response.
unifiedreturns the response with unified mappings applied.rawreturns the unprocessed, raw response from the remote API.normalizedapplies the unified mappings and returns the data in a normalized format.streamreturns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.
Defaults to unified.
unifiedunifiedrawnormalizedstream
By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.
idIgnores the limit query parameter.
Excludes the remote_data attribute from the response.
Array of fields to exclude from the response.
truto_exclude_fields[]=id&truto_exclude_fields[]=nameQuery parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.
remote_query[foo]=barResponse Body
The cursor to use for the next page of results. Pass this value as next_cursor in the query parameter in the next request to get the next page of results.
List of Campaigns
The unique identifier for the campaign.
3 supported
The unique identifier for the account.
2 supported
The bid strategy for the campaign.
2 supported
2 properties
The unique identifier for the bid strategy.
The name of the bid strategy.
lowest_cost_without_caplowest_cost_with_bid_capcost_cap
The budget for the campaign.
3 supported
7 properties
The daily max budget for the campaign.
The unique identifier for the budget.
Whether budget rebalancing is enabled for the campaign.
Whether budget scheduling is enabled for the campaign.
Whether the budget is shared for the campaign with other campaigns.
The max budget for the campaign.
The remaining budget for the campaign.
The buying type for the campaign.
auctionreserved
1 supported
The date and time the campaign was created.
2 supported
The labels for the campaign.
2 supported
2 properties
The unique identifier for the label.
The name of the label.
The name of the campaign.
3 supported
The objective of the campaign.
app_installsbrand_awarenessconversionsvisitsjob_applicationsevent_responseslead_generationlink_clickslocal_awarenessmessagesoffer_claimsoutcome_app_promotionoutcome_awarenessoutcome_engagementoutcome_leadsoutcome_salesoutcome_trafficpage_likespost_engagementproduct_catalog_salesreachstore_visitsvideo_views+ 11 more
2 supported
The primary attribution for the campaign.
1 supported
Raw data returned from the remote API call.
The special ad categories for the campaign.
1 supported
creditemploymenthousingnonepoliticalsocial_issues
The special ad category for the campaign.
creditemploymenthousingnonepoliticalsocial_issues
1 supported
The spend for the campaign.
1 supported
2 properties
Whether the cap is enabled for the campaign.
The max cap spend for the campaign.
The start time for the campaign.
2 supported
The status of the campaign.
activeinactivedraftpauseddeletedarchivedin_processwith_issuescompletedcanceledpending_deletion
3 supported
The stop time for the campaign.
2 supported
The type of the campaign
1 supported
The date and time the campaign was last updated.
2 supported
curl -X GET 'https://api.truto.one/unified/ads/campaigns?integrated_account_id=<integrated_account_id>' \
-H 'Authorization: Bearer <your_api_token>' \
-H 'Content-Type: application/json'const integratedAccountId = '<integrated_account_id>';
const response = await fetch(`https://api.truto.one/unified/ads/campaigns?integrated_account_id=${integratedAccountId}`, {
method: 'GET',
headers: {
'Authorization': 'Bearer <your_api_token>',
'Content-Type': 'application/json',
},
});
const data = await response.json();
console.log(data);import requests
url = "https://api.truto.one/unified/ads/campaigns"
headers = {
"Authorization": "Bearer <your_api_token>",
"Content-Type": "application/json",
}
params = {
"integrated_account_id": "<integrated_account_id>"
}
response = requests.get(url, headers=headers, params=params)
print(response.json())import Truto from '@truto/truto-ts-sdk';
const truto = new Truto({
token: '<your_api_token>',
});
const result = await truto.unifiedApi.list(
'ads',
'campaigns',
{ integrated_account_id: '<integrated_account_id>' }
);
console.log(result);import asyncio
from truto_python_sdk import TrutoApi
truto_api = TrutoApi(token="<your_api_token>")
async def main():
async for item in truto_api.unified_api.list(
"ads",
"campaigns",
{"integrated_account_id": "<integrated_account_id>"}
):
print(item)
asyncio.run(main())