Ricky logorickyDocs

Consultar resultados de campañas de Google Ads

GET
/ads/google/campaigns

Métricas en vivo de campañas de Google Ads y conversaciones de WhatsApp atribuidas a las cuentas publicitarias seleccionadas por la organizació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

Una cuenta de Google Ads seleccionada en Integraciones.

Patrón^\d{10}$
campaign_id?string

Solo esta campaña de Google Ads.

Patrón^\d{1,20}$
from*string

Primer día, incluido.

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 incluido. El periodo puede contener hasta 366 días.

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

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/google/campaigns?from=2019-08-24&to=2019-08-24'
{  "data": [    {      "account": {        "id": "string",        "name": "string",        "currency_code": "string",        "time_zone": "string"      },      "status": "ready",      "campaigns": [        {          "id": "string",          "name": "string",          "status": "string",          "spend": 0,          "clicks": 0,          "impressions": 0,          "conversions": 0,          "conversation_code": "string",          "conversation_count": -9007199254740991,          "recent_conversation_ids": [            "2bb8cacf-3506-46e4-be45-e228133b205b"          ]        }      ]    }  ],  "next_cursor": "string"}

Listar las conversaciones que trajeron los anuncios GET

Cada conversación que un anuncio de Meta abrió o trajo de vuelta en el período, de la más reciente a la más antigua, con el anuncio, el contacto, el estado de la conversación y las respuestas que recibió. Se lee de los mensajes de clientes que recibió Ricky, así que funciona sin conectar Meta Ads; el nombre, la campaña y el conjunto del anuncio (`ad_referral.resolved`) necesitan la conexión. El período son días de America/Panama, como en `GET /reports/ads`, y estas filas suman las conversaciones por anuncio de ese reporte. Permiso: `conversations:read`.

Listar agentes GET

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