Pular para o conteúdo

POST /v1/ads/table/search

POST
/v1/ads/table/search
curl --request POST \
--url https://seu-endereco-da-api/v1/ads/table/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "accountId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "adId": "example", "level": "campaign", "range": { "preset": "today", "since": "example", "until": "example" }, "compare": true, "filters": [ { "field": "name", "level": "campaign", "text": "example", "values": [ "example" ], "metric": "example", "operator": "gt", "amount": 1, "days": 1, "since": "example", "until": "example" } ], "draftIds": [ "example" ] }'

Permissão que a Chave de acesso precisa: Ler Meta Ads (ads:read).

Media typeapplication/json
object
accountId
string format: uuid
adId
string
level
required
string
Allowed values: campaign adset ad
range
required
object
preset
required
string
Allowed values: today yesterday today_and_yesterday last_7d last_14d last_28d last_30d this_week last_week this_month last_month maximum custom
since
string
until
string
compare
boolean
filters
Array<object>
object
field
required
string
Allowed values: name id delivery objective budget metric updated created
level
required
string
Allowed values: campaign adset ad
text
string
<= 200 characters
values
Array<string>
metric
string
<= 60 characters
operator
string
Allowed values: gt lt eq
amount
number
days
number
>= 1 <= 3650
since
string
until
string
draftIds
Array<string>
Media typeapplication/json
object
account
required
object
id
required
string
externalAccountId
required

Só dígitos; o act_ é prefixo de rota

string
name
required
string
currency
required
string
nullable
businessName
required
string
nullable
metaStatus
required

Reatualizado a cada leitura fresca da árvore na Meta

string
Allowed values: active disabled unsettled pending_risk_review pending_settlement in_grace_period pending_closure closed unknown
canManage
required
boolean
tokenStatus
required
string
Allowed values: valid expiring expired invalid unknown
missingScopes
required
Array<string>
Allowed values: ads_read ads_management business_management leads_retrieval pages_show_list pages_read_engagement pages_manage_metadata pages_manage_ads pages_messaging
level
required
string
Allowed values: campaign adset ad
range
required
object
firstDay
required
string format: date
lastDay
required
string format: date
previousRange
required
object
firstDay
required
string format: date
lastDay
required
string format: date
timezone
required
string
fetchedAt
required
string format: date-time
insightsAvailable
required
boolean
focus
required
object
campaignId
required
string
adsetId
required
string
adId
required
string
rows
required
Array<object>
object
level
required
string
Allowed values: campaign adset ad
id
required
string
name
required
string
status
required
string
Allowed values: ACTIVE PAUSED
effectiveStatus
required
string
Allowed values: ACTIVE PAUSED CAMPAIGN_PAUSED ADSET_PAUSED PENDING_REVIEW DISAPPROVED PREAPPROVED PENDING_BILLING_INFO IN_PROCESS WITH_ISSUES
delivery
required
string
Allowed values: active off in_review rejected issues completed draft
objective
required
string
nullable
budget
required
object
kind
required
string
Allowed values: daily lifetime
amount
required

Centavos da moeda da conta

number
budgetSource
required

Adset: a campanha usa o orçamento dos conjuntos

string
nullable
Allowed values: self adset campaign
campaignId
required
string
campaignName
required
string
adsetId
required
string
nullable
adsetName
required
string
nullable
thumbnailUrl
required
string
nullable
createdTime
required
string
nullable
updatedTime
required
string
nullable
resultKind
required
string
nullable
Allowed values: website_leads form_leads conversations purchases reach impressions link_clicks landing_page_views engagement thruplays page_likes app_installs
topLossReason
required
string
nullable
metrics
required

Métricas pela chave (spend, results, crmLeads…); dinheiro da Meta em centavos da moeda da conta

object
key
additional properties
number
nullable
previous
required

Métricas pela chave (spend, results, crmLeads…); dinheiro da Meta em centavos da moeda da conta

object
key
additional properties
number
nullable
totals
required
object
count
required
number
resultKind
required
string
nullable
Allowed values: website_leads form_leads conversations purchases reach impressions link_clicks landing_page_views engagement thruplays page_likes app_installs
topLossReason
required
string
nullable
metrics
required

Métricas pela chave (spend, results, crmLeads…); dinheiro da Meta em centavos da moeda da conta

object
key
additional properties
number
nullable
previous
required

Métricas pela chave (spend, results, crmLeads…); dinheiro da Meta em centavos da moeda da conta

object
key
additional properties
number
nullable

Example

{
"account": {
"metaStatus": "active",
"tokenStatus": "valid",
"missingScopes": [
"ads_read"
]
},
"level": "campaign",
"rows": [
{
"level": "campaign",
"status": "ACTIVE",
"effectiveStatus": "ACTIVE",
"delivery": "active",
"budget": {
"kind": "daily"
},
"budgetSource": "self",
"resultKind": "website_leads"
}
],
"totals": {
"resultKind": "website_leads"
}
}