Saltar a contenido

Método getAnalyticsData

getAnalyticsData

Descripción general. El método permite obtener un informe con datos de analítica de un proyecto concreto. Los informes se generan en modo offline. Es decir, es necesario consultar la API para comprobar si el informe está listo. Método: POST Enlace: https://api.r7k12.com/{{TOKEN}}/getAnalyticsData Encabezados. Encabezado obligatorio «Content-Type: application/json; charset=UTF-8»   Parámetros de la petición:

{

 "name": (string),

"metrics": [(string),...],

"dimensions": [(string),...],

"date": ("today"|"yesterday"|...|"last 30 day")|[(string),...],

"query": (string),

"bots": (bool),

 "eventData":(bool),

"page": (int)

}

Tabla 1 - Descripción de los parámetros

Parámetro Tipo Descripción Obligatorio
name string Nombre del informe Sí
metrics array of string Métricas del informe (descripción en la tabla 2) Sí
dimensions array of string Dimensiones del informe (descripción en la tabla 2). Si se indica una dimensión del informe incorrecta, se omitirá. Sí
date string or array of string Tipo de rango de fechas / intervalo de fechas. today - hoy yesterday - ayer week - semana actual month - mes actual previous week - semana anterior previous month - mes anterior last 7 day - últimos 7 días last 10 day - últimos 10 días last 14 day - últimos 14 días last 30 day - últimos 30 días [ ‘Y-m-d’, ‘Y-m-d’ ] - Intervalo de fechas Sí
query string Filtro para generar el informe (tabla 3) No
bots bool Excluir bots No
eventDate bool Tener en cuenta las fechas de los eventos No
page int Número de página solicitado No

Tabla 2 - Descripción de los filtros

Filtros
== Coincidencia exacta source1==yandex
!= No coincide source1!=yandex
=@ Contiene la subcadena source1=@yandex
!@ No contiene la subcadena source1!@yandex
=~ Contiene una coincidencia con la expresión regular source1=~yandex
!~ No coincide con la expresión regular source1!~yandex
Combinación
, «O» lógico source1==yandex,source1==google
; «Y» lógico source1==yandex;source1==google
*Al crear los filtros, el «O» lógico tiene prioridad sobre el «Y». Ejemplo: un filtro del tipo source1==yandex;source1==google,source1=facebook corresponderá a (source1 == ‘yandex’ && source1== ’google’) (source1 == ‘facebook’)*

Procesamiento de la respuesta:

{
    "name": (string),
    "status": (string),
    "fields": (array of object) [
        {
            "name": (string),
            "type": (string),
            "category": (string),
            "description": (string)
        },

…….
    ],
    "totals": (object),
    "count": (int),
    "interval": (object) {
        "from": (string),
        "to": (string)
    },
    "pages": (int),
    "page": (int),
    "data": (array of array),

    "error": (object){
        "code": (int),
        "error": (string),
        "error_detail": (string)
    }
}

Tabla 3 - Campos de la respuesta

Nombre Tipo Descripción Presencia
name string Nombre del informe Sí (si status - ready)
status string Estado de generación del informe. Es el parámetro principal de la respuesta, por el que debe empezar el procesamiento. Valores posibles: process - el informe se está generando. En este caso solo se devuelve el campo «status». Para comprobar si el informe está listo, es necesario repetir la petición con los mismos parámetros pasado un intervalo de tiempo. El intervalo de tiempo se determina en función de si la respuesta contiene el encabezado «retryIn»: si este encabezado está presente, la petición debe repetirse pasado el número de segundos indicado en él; de lo contrario, la petición se repite tras un intervalo de tiempo de no menos de 5 segundos, ya que, si no, se obtendrá un error de la API. La comprobación del encabezado retryIn es obligatoria. ready - el informe está listo. error - error al generar el informe Sí
fields array of object Descripción de los campos que se muestran en el informe. Los campos se indican en el mismo orden en que aparecen en el array «data». Sí (si status - ready)
fields[index].name string Nombre del campo (dimensión/métrica) Sí (si status - ready)
fields[index].type string Tipo de campo: INTEGER FLOAT
fields[index].category string Categoría del campo (dimensión/métrica): dimensions metrics
fields[index].description string Descripción del campo Sí (si status - ready)
totals object Objeto que contiene los datos totales de cada métrica del informe. Sí (si status - ready)
count int número total de filas del informe Sí (si status - ready)
interval object Intervalo de fechas para el que se generó el informe Sí (si status - ready)
interval.from string Fecha inicial en formato: Y-m-d Sí (si status - ready)
interval.to string Fecha final en formato: Y-m-d Sí (si status - ready)
pages int Número de páginas del informe. En una página se muestran como máximo 10000 filas de resultado. Si hay más de 1 página, es necesario repetir la petición indicando el parámetro «page» Sí (si status - ready)
page int Número de la página solicitada del informe Sí (si status - ready)
data array of array Array con los datos del informe. Cada fila se muestra en un array independiente. El orden de los elementos en los arrays de filas corresponde al orden de descripción de los campos en el elemento «fields» Sí (si status - ready)
error object Error al generar el informe de analítica. No confundir con los errores de la API Sí (si status - error)
error.code int Código de error Sí (si status - error)
error.error string Error Sí (si status - error)
error.error_detail string Descripción del error Sí (si status - error)

Limitaciones del método:

  1. En el servidor pueden almacenarse simultáneamente como máximo 60 informes
  2. Los informes se almacenan durante una hora
  3. El informe resultante no puede contener más de 1 millón de filas
  4. El volumen de datos procesados no puede superar los 20 Gb
  5. La petición repetida para comprobar el estado del informe debe enviarse no antes de 5 seg. o pasado el número de segundos indicado en el encabezado «retryIn».

Tabla 4 - Errores de generación del informe

Código Error Descripción
101 Parámetro de entrada incorrecto. No se ha indicado el campo obligatorio 'name' (Nombre del informe). Caracteres permitidos: 0-9,A-Z,a-z,А-Я,а-я,-,_,(,), (espacio).
102 Parámetro de entrada incorrecto. No se ha indicado el campo obligatorio 'metrics' (Métricas del informe) o tiene un formato no válido.
103 Parámetro de entrada incorrecto. No se ha indicado el campo obligatorio 'dimensions' (Dimensiones del informe) o tiene un formato no válido.
104 Parámetro de entrada incorrecto. El campo 'date' (Periodo del informe) contiene un valor incorrecto.
105 Cuota superada. En el servidor pueden almacenarse simultáneamente como máximo 60 informes. Los informes se almacenan 1 hora.
106 Parámetro de entrada incorrecto. El parámetro de entrada 'page' contiene un valor incorrecto.
111 Cuota superada. El informe puede contener como máximo 1 millón de registros.
112 Cuota superada. Se permite como máximo 1 petición cada 5 segundos.
117 Cuota superada. Se ha superado la cuota de volumen de datos procesados.
0 Error desconocido

Ejemplo de llamada al método (PHP):

define('TOKEN','YOURTOKEN');

function POST ($request) {
   $curl = curl_init();
   curl_setopt($curl, CURLOPT_URL, 'https://api.r7k12.com/'.TOKEN.'/getAnalyticsData');
   curl_setopt($curl, CURLOPT_RETURNTRANSFER,true);
   curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode($request,JSON_UNESCAPED_UNICODE));
   $out = curl_exec($curl);
   curl_close($curl);
   return json_decode($out,true);
}

$response = POST(
   [
       'name' => 'API R7K12',
       'metrics' => [
           'sessions',
           'cost',
           'impressions'
       ],
       'dimensions' => [
           'nameProject',
           'idProject'
       ],
       'date' => 'today',
       'bots' => true,
       'eventDate' => false
   ]
);

print_r($response);