Propósito de esta API

Posibilitar la consulta de conjunto de datos de una analítica creada anteriormente en Delio a través de una llamada API REST (POST/GET) donde se devuelve los datos de la analítica en un formato definido.

API

delioAnalytics_getByIdTag

Webservice que, dado un idTag, devuelve un objeto JSOn con las analiticas y descripciones que contiene dicho idTag.

Url de la API

http://ws.walmeric.com/provision/wsanalytics/delioAnalytics_getByIdTag.html

Parámetros de entrada de la API

Ejemplo de llamada GET

http://ws.walmeric.com/provision/wsanalytics/delioAnalytics_getByIdTag.html?format=json&idTag=<<IDTAG>>

Respuesta del servicio

[
  {
    "idAnalysis": "c4ca4238a0b923820dcc509a6f75849b",
    "description": "Analisis 1"
  },
  {
    "idAnalysis": "eccbc87e4b5ce2fe28308fd9f2a7baf3",
    "description": "analisis 2"
  },
  {
    "idAnalysis": "45c48cce2e2d7fbdea1afc51c7c6ad26",
    "description": "analisis 3"
  },
  {
    "idAnalysis": "6512bd43d9caa6e02c990b0a82652dca",
    "description": "analisis 4"
  }
]

nota: el array se devolvera vacio en caso de no tener ninguna analitica enlazada.

delioAnalytics_get

Webservice para la consulta de leads/conversiones dado un id de una analitica

Url de la API

http://ws.walmeric.com/provision/wsanalytics/delioAnalytics_get.html

Parámetros de entrada de la API

nota: Si se manda fecha de inicio o final, es obligatorio mandar la fecha faltante. Si no se manda fechas se tomara las fechas o intervalos definidos en la analítica.

Ejemplo de llamada GET

http://ws.walmeric.com/provision/wsanalytics/delioAnalytics_get.html?format=json&idTag=<<IDTAG>>&analysisId=<<IDANALISIS>>&dateInit=2016-08-19&dateEnd=2016-09-01

Respuesta del servicio

• Analytic description: Descripción registrada junto a la analítica en Delio
• data: Conjunto de datos de la analítica.
  • Los datos estarán compuestos de dos partes:
    • Cabeceras (titles): Ejes definidos en la analítica para contrastar y segmentar la información (Rows y Columns).
    • Lineas de datos (rows): Matriz con el conteo de datos segmentados por las cabeceras.
    • Capas (layers): Si hay especificadas capas en el análisis estarán por separado en esta sección. Tener en cuenta que las capas es un conteo global reemplazando el funnel por la etiqueta filtrada, y segmentada por las filas (Rows)

Dependiendo del tipo de analítica, la representación de los datos sera de diferente manera:

Analitica de lineas progresiva o progresivo de barras

Rows: Puede tener valor "Hours" si el gráfico esta segmentado por horas o "Dates" si el gráfico esta segmentado por días.

Columns: Etiqueta utilizada para segmentar cada una de las fechas/horas.

Ejemplo JSON

{
	"Analytic description": "Clic vs Lead",
	"data": {
		"titles": {"Rows": "Hours", "Columns": "campaign"},
		"rows": {
			"00": [{"coche_genericos": 1}, {"marca": 17}, {"mejorprecio": 253}, {"moto": 1}, {"organic": 6}],
			"01": [{"3x1": 2}, {"marca": 5}, {"mejorprecio": 150}, {"organic": 1}],
			"02": [{"Visita Directa": 1}, {"3x1": 1}, {"mejorprecio": 36}, {"organic": 2}],
			"03": [{"Visita Directa": 2}, {"mejorprecio": 17}, {"organic": 1}],
			"04": [{"mejorprecio": 9}, {"organic": 1}],
			"05": [{"Visita Directa": 1}, {"3x1": 1}, {"marca": 2}, {"mejorprecio": 8}],
			"06": [{"Visita Directa": 1}, {"marca": 8}, {"mejorprecio": 43}, {"organic": 5}],
			"07": [{"Visita Directa": 1}, {"coche": 1}, {"marca": 21}, {"mejorprecio": 97}, {"nurturing": 1}, {"organic": 6}],
			"08": [{"Visita Directa": 3}, {"coche_barato": 2}, {"coche_genericos": 1}, {"facebook": 1}, {"marca": 108}, {"mejorprecio": 218}, {"nurturing": 1}, {"organic": 5}],
			"09": [{"Visita Directa": 4}, {"coche": 6}, {"coche_barato": 4}, {"coche_genericos": 4}, {"facebook": 10}, {"marca": 326}, {"mejorprecio": 389}, {"moto": 1}, {"nurturing": 11}, {"organic": 4}, {"seguros_barato": 4}],
			"10": [{"Visita Directa": 10}, {"calcular_coche": 1}, {"coche": 1}, {"coche_barato": 4}, {"coche_genericos": 5}, {"facebook": 9}, {"marca": 512}, {"mejorprecio": 586}, {"moto": 1}, {"nurturing": 21}, {"organic": 9}],
			"11": [{"Visita Directa": 21}, {"coche": 6}, {"coche_barato": 4}, {"coche_genericos": 5}, {"facebook": 9}, {"marca": 570}, {"mejorprecio": 651}, {"moto": 2}, {"nurturing": 27}, {"organic": 12}]
		},
		"layers": {
			"Leads": [{"00": 40}, {"01": 19}, {"02": 3}, {"03": 1}, {"05": 2}, {"06": 14}, {"07": 33}, {"08": 137}, {"09": 444}, {"10": 708}, {"11": 835}]
		}
	}
}

Analitica de barras acumulado o de tarta acumulado

Pueden ser de dos tipos:

• Comparación de una etiqueta contra el funnel
• Comparación entre dos etiquetas

Rows: Puede ser el funnel (Aparecerá la palabra "funnels" en dicho caso) o una de las etiquetas seleccionadas.

Columns: Una de las etiquetas seleccionadas para la analítica.

Ejemplo JSON

// Una etiqueta sobre el funnel
{
	"Analytic description":"Nivel Atenci\u00f3n Call Center",
	"data":{
		"titles":{"Rows":"Site Conversion","Columns":"funnels"},
		"rows":{
			"Clicks":[{"anuncio":5377},{"contratacion":12},{"cotizador":157},{"landing":1945},{"presupuesto":25}],
			"Leads":[{"anuncio":5377},{"contratacion":12},{"cotizador":158},{"landing":1917},{"presupuesto":25}],
			"Cualificados":[{"anuncio":2019},{"contratacion":11},{"cotizador":138},{"landing":1228},{"presupuesto":25}],
			"Prospectos":[{"anuncio":1398},{"contratacion":11},{"cotizador":102},{"landing":937},{"presupuesto":25}],
			"Cotizaciones":[{"anuncio":411},{"contratacion":10},{"cotizador":32},{"landing":282},{"presupuesto":25}],
			"Ventas":[{"anuncio":275},{"contratacion":3},{"cotizador":16},{"landing":157},{"presupuesto":7}]
		}
	}
}


//Comparativa dos etiquetas
{
	"Analytic description":"Nivel Atencion CC por Tipo llamada",
	"data":{
		"titles":{"Rows":"Nivel de Atencion CallCenter","Columns":"Tipo Llamada"},
		"rows":{
			"Primer intento":[{"Tipo 1":2796},{"Tipo 2":236},{"Convertida Tipo 2":23}],
			"Siguientes intentos":[{"Tipo 2":33},{"Convertida Tipo 2":141}],"Perdida":[{"Convertida Tipo 2":5}]
		}
	}
}

Analitica de tabla

Sacara en un mismo objeto tanto las capas seleccionadas como la capa leads de una tabla.

Rows: Etiqueta seleccionada para acumular.

Columns: capas del funnel a sacar (clicks, leads, ...)

Ejemplo JSON

{
	"Analytic description":"Funnel Vs Site Conversion Facebook",
	"data":{
		"titles":{"Rows":"Site Conversion","Columns":"funnels"},
		"rows":{
			"cotizador":[{"Leads":1},{"Cualificados":1},{"Prospectos":1}],
			"post":[{"Leads":20},{"Cualificados":7},{"Prospectos":5}]
		}
	}
}

Analitica de Funnel

Se sacara solo una columna por cada uno de los niveles de funnel filtrados por las etiquetas definidas en la analítica.

Rows: Los funnels habilitados en el cliente de Delio.

{
	"Analytic description":"Funnel",
	"data":{
		"titles":{"Rows":"funnels"},
		"rows":[{"Clicks":0},{"Leads":0},{"Cualificados":0},{"Prospectos":0},{"Cotizaciones":0},{"Ventas":0}]
	}
}

Errores controlados

Ejemplo ERROR JSON

{"errors":{"code":487,"message":"No se tiene permiso con dicho idTag para el análisis solicitado."}}

Consideraciones

• Dependiendo de la complejidad y el rango de fechas solicitado, la API puede tardar bastante en contestar.
• Una vez se ha obtenido la respuesta, dicha respuesta se cacheara en nuestro sistema durante una hora. Por ello puede haber diferencias entre lo que responde trustview en la web, a la respuesta de la API. Una vez pasada la hora se volverá a procesar.

delioAnalytics_processAsync

Webservice para la ejecucion asincrona de una analitica

Url de la API

http://ws.walmeric.com/provision/wsanalytics/delioAnalytics_processAsync.html

Parámetros de entrada de la API

nota: Si se manda fecha de inicio o final, es obligatorio mandar la fecha faltante. Si no se manda fechas se tomara las fechas o intervalos definidos en la analítica.

Ejemplo de llamada GET

http://ws.walmeric.com/provision/wsanalytics/delioAnalytics_processAsync.html?format=json&idTag=<<IDTAG>>&analysisId=<<IDANALISIS>>&dateInit=2016-08-19&dateEnd=2016-09-01

Respuesta del servicio

Devolvera un hash "analysisHash" de la analitica que es lo que se debera usar mas tarde, en el webservice de consulta de las analiticas "delioAnalytics_getAsync", para saber si esta listo los datos.

{
   "analysisHash": "4fc9d2f86cf64fc61f4798b85e64af40"
}
  

Errores controlados

Ejemplo ERROR JSON

{"errors":{"code":487,"message":"No se tiene permiso con dicho idTag para el análisis solicitado."}}

delioAnalytics_getAsync

Webservice para la recuperacion asincrona de una analitica

Url de la API

http://ws.walmeric.com/provision/wsanalytics/delioAnalytics_getAsync.html

Parámetros de entrada de la API

Ejemplo de llamada GET

http://ws.walmeric.com/provision/wsanalytics/delioAnalytics_getAsync.html?format=json&idTag=<<IDTAG>>&analysisHash=<<IDANALISIS>>

Respuesta del servicio

Se devolvera el resultado del proceso de la analitica. Vease el webservice "delioAnalytics_get".

Errores controlados

Ejemplo ERROR JSON

{"errors":{"code":489,"message":"Analitica en progreso."}}

delioAnalytics_getHeaders

Webservice para la recogida de las cabeceras de una analitica

Url de la API

http://ws.walmeric.com/provision/wsanalytics/delioAnalytics_getHeaders.html

Parámetros de entrada de la API

Ejemplo de llamada GET

http://ws.walmeric.com/provision/wsanalytics/delioAnalytics_getHeaders.html?format=json&idTag=<<IDTAG>>&analysisId=<<IDANALISIS>>

Respuesta del servicio

Devolvera un JSON con las descripciones de las cabeceras de los ejes de las analiticas y su tipo de dato, ya sea texto o numero

{
    "ESTADO_CONTACTO": "text",
    "Visitas": "int",
    "Leads": "int",
    "Llamadas": "int",
    "Llamadas Conectadas": "int",
    "Llamadas Cualificadas": "int",
    "Tarificación": "int",
    "Ventas": "int"
}

Errores controlados

Ejemplo ERROR JSON

{"errors":{"code":487,"message":"No se tiene permiso con dicho idTag para el análisis solicitado."}}