POST /v1/ads/table/search
POST
/v1/ads/table/search
const url = 'https://seu-endereco-da-api/v1/ads/table/search';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"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"]}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}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).
Authorizations
Seção intitulada “Authorizations”Request Bodyrequired
Seção intitulada “Request Bodyrequired”Media typeapplication/json
object
accountId
string format: uuid
adId
string
level
required
string
range
required
object
preset
required
string
since
string
until
string
compare
boolean
filters
Array<object>
object
field
required
string
level
required
string
text
string
values
Array<string>
metric
string
operator
string
amount
number
days
number
since
string
until
string
draftIds
Array<string>
Responses
Seção intitulada “Responses”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
businessName
required
string
metaStatus
required
Reatualizado a cada leitura fresca da árvore na Meta
string
canManage
required
boolean
tokenStatus
required
string
missingScopes
required
Array<string>
level
required
string
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
id
required
string
name
required
string
status
required
string
effectiveStatus
required
string
delivery
required
string
objective
required
string
budget
required
object
kind
required
string
amount
required
Centavos da moeda da conta
number
budgetSource
required
Adset: a campanha usa o orçamento dos conjuntos
string
campaignId
required
string
campaignName
required
string
adsetId
required
string
adsetName
required
string
thumbnailUrl
required
string
createdTime
required
string
updatedTime
required
string
resultKind
required
string
topLossReason
required
string
metrics
required
Métricas pela chave (spend, results, crmLeads…); dinheiro da Meta em centavos da moeda da conta
object
key
additional properties
number
previous
required
Métricas pela chave (spend, results, crmLeads…); dinheiro da Meta em centavos da moeda da conta
object
key
additional properties
number
totals
required
object
count
required
number
resultKind
required
string
topLossReason
required
string
metrics
required
Métricas pela chave (spend, results, crmLeads…); dinheiro da Meta em centavos da moeda da conta
object
key
additional properties
number
previous
required
Métricas pela chave (spend, results, crmLeads…); dinheiro da Meta em centavos da moeda da conta
object
key
additional properties
number
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" }}