Ricky logorickyDocs

Consultar los resultados de los anuncios de Meta

GET
/ads/insights

El gasto, la entrega y las acciones que cuenta Meta para las cuentas publicitarias conectadas en un período, por cuenta, campaña, conjunto o anuncio, calculados en vivo por Meta. Responde rule_violation cuando la organización no conectó Meta Ads, y forbidden cuando Meta ya no acepta su conexión.

Permiso: reports:read.

Autorización

bearerAuth
headerAuthorizationBearer <clave>

Una clave de API de la organización, rky_live_…, creada en Configuración → API. Envíala solo desde un servidor.

Parámetros de consulta

account_id?string

Solo esta cuenta publicitaria conectada.

Patrón^\d+$
level?string

Una fila por cuenta publicitaria, campaña, conjunto o anuncio.

Predeterminado"campaign"
Uno de"account""campaign""ad_set""ad"
from*string

Primer día, YYYY-MM-DD, en la zona horaria de la cuenta publicitaria.

Patrón^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
Formatodate
to*string

Último día, YYYY-MM-DD, incluido. Como máximo 400 días después de from.

Patrón^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
Formatodate
breakdowns?string

Divide las filas por hasta dos de age, gender, country, region, publisher_platform, platform_position, device_platform, separados por coma.

Patrón^(age|gender|country|region|publisher_platform|platform_position|device_platform)(,(age|gender|country|region|publisher_platform|platform_position|device_platform))?$
daily?string

true devuelve una fila por día en vez de una por período.

Predeterminado"false"
Uno de"true""false"
object_id?string

Solo esta campaña, conjunto o anuncio.

Patrón^\d+$

Cuerpo de la respuesta

Éxito.

application/json
  1. response
data*array<>
next_cursor*|

Pásalo como cursor para la página siguiente; null en la última página.

curl -X GET 'https://getricky.ai/api/v1/ads/insights?from=2019-08-24&to=2019-08-24'
{  "data": [    {      "account_id": "string",      "campaign_id": "string",      "campaign_name": "string",      "ad_set_id": "string",      "ad_set_name": "string",      "ad_id": "string",      "ad_name": "string",      "date_start": "2019-08-24",      "date_stop": "2019-08-24",      "breakdown": {        "property1": "string",        "property2": "string"      },      "currency_code": "string",      "spend": 0,      "impressions": 0,      "reach": 0,      "frequency": 0,      "clicks": 0,      "ctr": 0,      "cpc": 0,      "cpm": 0,      "actions": [        {          "action_type": "string",          "value": 0        }      ],      "cost_per_action": [        {          "action_type": "string",          "value": 0        }      ]    }  ],  "next_cursor": "string"}

Listar los anuncios de Meta GET

Los anuncios de las cuentas publicitarias de Meta conectadas, con el texto de su creativo, leídos en vivo de Meta. Responde `rule_violation` cuando la organización no conectó Meta Ads, y `forbidden` cuando Meta ya no acepta su conexión. Permiso: `reports:read`.

Listar agentes GET

Los agentes activos, primero los más recientes. Los agentes archivados no aparecen. Permiso: `agents:read`.