API de Chartboost

Última actualización:

 

Con el API de Chartboost puedes acceder a las analíticas de aplicación y campaña, obtener información de cuenta e ingresos, cargar, actualizar las pujas de tus campañas y mucho más.

 

 

  • Autenticación: debes incluir el ID de usuario y la firma de usuario de tu cuenta para autenticar tus solicitudes API. Puedes encontrar tu ID y firma de usuario en la parte superior de la página Explorador de API del panel de control.
  • Métodos HTTP: los métodos HTTP requeridos (GET, POST, PUT, etc.) varían según el endpoint. Puedes ver el método HTTP de cada solicitud en el Explorador API de tu panel de control. Todas las solicitudes deben hacerse vía HTTPS. El ejemplo de abajo muestra dos consultas: una solicitud inicial para poner la tarea en espera y la consulta posterior que usa el ID de tarea para obtener los resultados:
// ejemplo de pseudo-código para la solicitud de consulta inicial
query_url = "http://analytics.chartboost.com/v3/metrics/campaign?" + query_params
query_params = "... groupBy=app,creative ..."

response = get(query_url);
if (response.status = 202) {
 jobId = response.parse('jobId');
// captura el jobId (ID de tarea) para la función retrieve() (obtener)
 file.write(jobId);
 }
else {
// manejo del fallo
};


// ejemplo de pseudo-código para obtener resultados por jobId
query_url = "http://analytics.chartboost.com/v3/metrics/jobs/" + jobId
query_params = ""

created = get(query_url + "?status=true");
if (created.status == 201) {
response = get(query_url);
if (response.status == 200) {
// explora los datos
}
else {
// manejo del fallo
}
};
  • Después de recibir consultas GET /campaign y GET /install con el parámetro groupBy. el API de Chartboost API responderá con un ID de tarea que sirve como confirmación de que la solicitud ha sido aceptada y está en espera para ser procesada.
  • Ahora puedes usar el ID para ver el estado de la tarea en una solicitud posterior con este endpoint: GET /v3/metrics/jobs/[job_id]?status=true
  • La consulta devolverá 201 {status: "created"} cuando los resultados de estén listos. Una vez que tu sistema reciba esta respuesta puedes obtener los datos con: GET /v3/metrics/jobs/[job_id]
  • Si intentas obtener los datos antes de que la tarea esté terminada, recibirás una respuesta vacía o incompleta.
  • Los resultados de la consulta quedarán almacenados y disponibles durante 24 horas antes de ser borrados.
  • Actualmente el único content-type admitido es application/octet-stream, que ofrece los resultados en formato TSV con extensión .cvs.
  • Métodos API: el API de Chartboost incluye cuatro tipos de métodos: métodos de analíticas, métodos de aplicación, métodos de campaña y métodos de cuenta. Cada tipo de método tiene endpoints únicos. Utiliza el Explorador API de tu panel de control o una de las opciones de abajo para encontrar el endpoint correspondiente a tu solicitud.
  • Parámetros: añade parámetros para creare tus solicitudes de prueba. Lo parámetros requeridos aparecen en rojo en tu panel de control.
  • La mayoría de los informes de analíticas de nuestro API están en formato JSON. Las consultas específicas obtienen respuesta en formato TSV (valores separados por tabuladores). Más información sobre los formatos ▶
  • Sigue las reglas del API de Chartboost descritas más abajo.

▲ Volver arriba

 

Estas directrices nos ayudan a que las solicitudes de todos nuestros clientes se procesen con rapidez. Si no las respetas, limitaremos tu acceso al API.

Pórtate bien con nuestro API por ti y por los demás clientes de Chartboost.
Espacia tus solicitudes. Si necesitas recibir cinco informes al día, no envíes las cinco solicitudes al mismo tiempo. Deja pasar al menos unos minutos entre una y otra. Tu acceso al API quedará limitado si envías más de una solicitud por minuto.
Agrupa tus aplicaciones en una única solicitud. En lugar de enviar una solicitud para cada aplicación, omite el parámetro appId de forma que el API te entregue datos de todas.

▲ Volver arriba

 

Métodos de analíticas Métodos de aplicación Métodos de campaña Métodos de cuenta

 


Quizás también te interese...