Skip to content

Get Campaigns

Endpoint

http
GET /unified/ads/campaigns/{id}
Integrations supported
  • Meta Marketing API

Path parameters

id
string
REQUIRED · The ID of the resource.
Example: 23423523

Query parameters

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · The ID of the integrated account to use for the request.
Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string
The format of the response. Defaults to `unified`. `unified` will return the response with unified mappings applied. `raw` will return the raw response from the remote API. `normalized` will apply the unified mappings and return the data in a normalized format.
All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_ignore_remote_data
boolean
Excludes the `remote_data` attribute from the response.
truto_exclude_fields
array
Array of fields to exclude from the response.
Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object
Query parameters to pass to the underlying API without any transformations.
Example: remote_query[foo]=bar

Response Body

id
string
REQUIRED · The unique identifier for the campaign.
Supported in
  • Meta Marketing API
name
string
The name of the campaign.
Supported in
  • Meta Marketing API
status
string
The status of the campaign.
All possible enum values:
  • active
  • paused
  • deleted
  • archived
  • in_process
  • with_issues
Supported in
  • Meta Marketing API
labels
object[]
The labels for the campaign.
Supported in
  • Meta Marketing API
id
string
The unique identifier for the label.
name
string
The name of the label.
objective
string
The objective of the campaign.
All possible enum values:
  • app_installs
  • brand_awareness
  • conversions
  • event_responses
  • lead_generation
  • link_clicks
  • local_awareness
  • messages
  • offer_claims
  • outcome_app_promotion
  • outcome_awareness
  • outcome_engagement
  • outcome_leads
  • outcome_sales
  • outcome_traffic
  • page_likes
  • post_engagement
  • product_catalog_sales
  • reach
  • store_visits
  • video_views
Supported in
  • Meta Marketing API
bid_strategy
object
The bid strategy for the campaign.
Supported in
  • Meta Marketing API
id
string
The unique identifier for the bid strategy.
name
string
The name of the bid strategy.
All possible enum values:
  • lowest_cost_without_cap
  • lowest_cost_with_bid_cap
  • cost_cap
buying_type
string
The buying type for the campaign.
All possible enum values:
  • auction
  • reserved
Supported in
  • Meta Marketing API
budget
object
The budget for the campaign.
Supported in
  • Meta Marketing API
id
string
The unique identifier for the budget.
remaining
string
The remaining budget for the campaign.
lifetime_max
string
The max budget for the campaign.
daily_max
string
The daily max budget for the campaign.
is_scheduling_enabled
boolean
Whether budget scheduling is enabled for the campaign.
is_rebalance_enabled
boolean
Whether budget rebalancing is enabled for the campaign.
is_shared
boolean
Whether the budget is shared for the campaign with other campaigns.
spend
object
The spend for the campaign.
Supported in
  • Meta Marketing API
max_cap
string
The max cap spend for the campaign.
cap_enabled
boolean
Whether the cap is enabled for the campaign.
primary_attribution
string
The primary attribution for the campaign.
Supported in
  • Meta Marketing API
special_ad_categories
string[]
The special ad categories for the campaign.
Supported in
  • Meta Marketing API
All possible enum values:
  • credit
  • employment
  • housing
  • none
  • political
  • social_issues
special_ad_category
string
The special ad category for the campaign.
All possible enum values:
  • credit
  • employment
  • housing
  • none
  • political
  • social_issues
Supported in
  • Meta Marketing API
start_time
string · date-time
The start time for the campaign.
Supported in
  • Meta Marketing API
stop_time
string · date-time
The stop time for the campaign.
Supported in
  • Meta Marketing API
created_at
string · date-time
The date and time the campaign was created.
Supported in
  • Meta Marketing API
updated_at
string · date-time
The date and time the campaign was last updated.
Supported in
  • Meta Marketing API
remote_data
object
Raw data returned from the remote API call.