A continuación se presentan las rutas que se pueden targetear, se mostrarán ejemplos de uso y se explicarán los parámetros que se deben entregar en caso de ser necesarios.
Antes de cada uno de los valores de respuesta en los json se presenta su tipo, de la siguiente manera:
Cada uno de los json de respuesta se darán en caso de llamar correctamente a la ruta, lo cual se puede corrobar si se obtiene el status 200, de lo contrario se podría obtener un 403 puesto que no se cuentan con los permisos para acceder a la ruta, ya sea por las cualidades de la cuenta o por el dato solicitado, como se aprecia a un costado en el ejemplo.
Status: 403
{
"error": "Access restricted to this data",
"fullError":
{
"chinchayCode": "forbidden"
}
}
Todos los datos que son accesibles desde la plataforma, en la sección de Anuncios que tiene el usuario, serán accesibles desde la API a través de las siguientes rutas.
Para algunos de los endpoints se puede especificar un anuncio en particular, el cual se puede elegir con un sponsor_id, este es el número identificador de cada uno de sus anuncios, el cual lo puede encontrar en el endpoint asociado a Información de Anuncios, en el campo de "id"
Cada una de las posibilidades ofrecidas por la lista de parámetros disponibles se usan directamente con el endpoint o se usan con la sintaxis mostrada a un costado
GET endpoint?parámetro1=valor1
GET endpoint?parámetro1=valor1&parámetro2=valor2&parámetro3=valor3 ...
Obtener todos tus anuncios y sus datos, incluídos los Id's para el resto de endpoints.
GET /api/v3/sponsor/find
Status: 200
{
'message': 'Sponsor enviados exitosamente',
'data':
[
{
'id': int id,
'name': 'str nombreAnuncio',
'type': int tipo,
'description': "str descripción",
"is_active": bool valor,
"profile_image": "str linkImagen",
"cover_image": "str linkImagen",
"created_at": "YYYY-MM-DDTHH:MM:SS.sssZ",
"updated_at": "YYYY-MM-DDTHH:MM:SS.sssZ",
"places": ["str idRed", "str idRed", ...],
"min_age": int edad,
"max_age": int edad,
"gender": "str género",
"start_date": "YYYY-MM-DDTHH:MM:SS.sssZ",
"end_date": "YYYY-MM-DDTHH:MM:SS.sssZ",
"locale": "str LL",
"weekdays": ["str día", "str día", ...],
"absolut_importance": int importancia,
"score": float puntaje,
"min_hour": int hora,
"max_hour": int hora,
"require_lead": bool valor,
"mail_content": "str contenido del correo",
"automatic_mailing": bool valor,
"mail_subject": "str asunto del correo",
"mail_sender": "str emisor del correo",
"label": "str etiqueta",
"nationalities":["str country", "str country", ...],
"os": "str sistemaOperativo",
"special_event": "str evento",
"current_status": "str estado",
"limit_per_user": int límite,
"phone_message": "str mensaje",
"has_coupons": bool valor,
"max_impressions": int máximo,
"android_mailing": bool valor
}, ...
]
}
Cantidad de veces que sus anuncios han sido desplegados en un dispositivo, puede ser más de una vez por usuario.
Parámetros posibles:
GET /api/v3/sponsor/impressions/count
Status: 200
{
"message": "Impresiones publicitarias totales.",
"data": int cantidadImpresiones
}
Cantidad de veces que se mostraron sus anuncios, detallados por fecha.
Parámetros posibles:
GET /api/v3/sponsor/impressions/by/day
Status: 200
{
"message": "impression de sponsor por dia",
"data":
[
["YYYY-MM-DD", "str cantidadImpresiones1"],
["YYYY-MM-DD", "str cantidadImpresiones2"], ...
]
}
Cantidad de veces que se mostraron sus anuncios, detallado en cada hora del día.
Comenzando por 0 y terminando en 23, acompañado de la cantidad pedida.
Parámetros posibles:
GET /api/v3/sponsor/impressions/by/hour
Status: 200
{
"message": "impression de sponsor por hora",
"data":
[
[0, int cantidadImpresiones],[1, int cantidadImpresiones], ...
[22, int cantidadImpresiones], [23, int cantidadImpresiones]
]
}
Cantidad de usuarios que han visto un anuncio en particular.
Para obtener el número correcto de personas que han visto el anuncio es necesario usar exactamente el endpoint brindado, dado que no utilizar los parámetros específicos la cantidad podría no ser adecuada.
GET /api/v3/endusers/count/unique/per/day?sponsor_id=:id&event=impression
Status: 200
{
"message": "Busqueda encontrada exitosamente",
"data": "str cantidadUsuarios"
}
Cantidad de usuarios nuevos que han visto un anuncio en particular, detallado por fecha.
GET /api/v3/endusers/creation/per/day?sponsor_id=:id
Status: 200
{
"message": "Busqueda encontrada exitosamente",
"data":
[
{
"date": "YYYY-MM-DD",
"count": int cantidadUsuarios
},
{
"date": "YYYY-MM-DD",
"count": int cantidadUsuarios
}, ...
]
}
Cantidad de veces que se ha hecho click sus anuncios.
Parámetros posibles:
GET /api/v3/sponsor/click/count
Status: 200
{
"message": "Click de sponsor totales.",
"data": int cantidadClicks
}
Cantidad de clicks en los anuncios, detallados por fechas.
Parámetros posibles:
GET /api/v3/sponsor/click/by/day
Status: 200
{
'message': 'click de sponsor por dia',
'data':
[
['YYYY-MM-DD', 'str cantidadClicks'],
['YYYY-MM-DD', 'str cantidadClicks'], ...
]
}
Cantidad de clicks en sus anuncios, detallado en cada hora del día.
Parámetros posibles:
GET /api/v3/sponsor/click/by/hour
Status: 200
{
"message": "click de sponsor por hora",
"data":
[
[0, int cantidadClicks],[1, int cantidadClicks], ...
[22, int cantidadClicks], [23, int cantidadClicks]
]
}
Datos de las preguntas a los usuarios, retornando la pregunta y la cantidad de veces que cada opción se marcó
Es necesario especificar el id del anuncio, de lo contrario la cantidad retornada podría no ser correcta.
GET /api/v3/person/count?sponsor_id=:id&groupBy=:filter
Status: 200
groupBy(gender/locale):
{
"message": "Personas contadas exitosamente",
"count":
[
{
"count": "str cantidadPersonas",
"filter": "str respuestaFilter"
}, ...
{
"count": "str cantidadPersonas",
"filter": null
}
]
}
groupBy(age):
{
"message": "Personas contadas exitosamente",
"count":
{
"gender1":
{
"str edad": int cantidadPersonas,
"str edad": int cantidadPersonas,
...
"str null": int cantidadPersonas
},
"gender2":
{
"str edad": int cantidadPersonas,
"str edad": int cantidadPersonas,
...
"str null": int cantidadPersonas
}, ...
}
}
Cantidad de mails enviados, asociados a un anuncio en particular
Para utilizar el endpoint es necesario reemplazar ":sponsor_id" con el número de id asociado al anuncio que se quiera consultar.
GET /api/v3/sponsor/:sponsor_id/leads/count
Status: 200
{
'message': 'Busqueda encontrada exitosamente',
'leads': 'str cantidadMails'
}
Mails asociados a un anuncio, con todos sus datos
Para utilizar el endpoint es necesario reemplazar ":sponsor_id" con el número de id asociado al anuncio que se quiera consultar.
GET /api/v3/sponsor/:sponsor_id/leads/find
Status: 200
{
'message': 'Busqueda encontrada exitosamente',
'leads':
[
{
"id": int idMail,
"sponsor_id": int idAnuncio,
"text": "str correo@test.com",
"created_at": "YYYY-MM-DDTHH:MM:SS.sssZ",
"updated_at": "YYYY-MM-DDTHH:MM:SS.sssZ",
"mail_sent": bool value,
"mail_recieved": bool value,
"mail_sent_date": "YYYY-MM-DDTHH:MM:SS.sssZ",
"macaddress": "T-FF:FF:FF:FF:FF:FF",
"is_android": bool value,
"event_id": "str eventId",
"message_id": "str messageId",
"mail_recieved_date": "YYYY-MM-DDTHH:MM:SS.sssZ",
"mail_opened": bool value,
"mail_opened_date": bool value,
"mail_clicked": bool value,
"clicks": bool value,
"mail_bounced": bool value,
"place_id": int placeId,
"timezone": "str +HH"
}, ...
]
}
Cantidad de anuncios asociados a su cuenta
GET /api/v3/sponsor/count
Status: 200
{
'message': 'Amount of sponsorships where counted successfully',
'amount': 'str cantidadAnuncios'
}
Todos los datos que son accesibles desde la plataforma, en la sección de Research que tiene el usuario, serán accesibles desde la API a través de las siguientes rutas.
Para algunos de los endpoints se puede especificar un research en particular, el cual se puede elegir con un gather_id, este es el número identificador de cada uno de sus perfilamientos o insights, el cual lo puede encontrar en el endpoint asociado a Información de Research, en el campo de "id"
Cada una de las posibilidades ofrecidas por la lista de parámetros disponibles se usan directamente con el endpoint o con la sintaxis mostrada a un costado
GET endpoint?parámetro1=valor1
GET endpoint?parámetro1=valor1&parámetro2=valor2&parámetro3=valor3 ...
Información de Perfilamientos e Insights asociados a una cuenta
GET /api/v3/gather/find
Status: 200
{
'message': 'Busqueda encontrada exitosamente',
'data':
[
{
"id": int researchId,
"type": "str tipoPregunta",
"text": "srt nombre",
"created_at": "YYYY-MM-DDTHH:MM:SS.sssZ",
"updated_at": "YYYY-MM-DDTHH:MM:SS.sssZ",
"priority": int value,
"options": ["str options","str options", ...],
"is_active": bool value,
"questions":
{
"type": "str tipoPregunta",
"textEN": "str preguntaIngles1",
"textES": "str preguntaEspañol1",
"textPT": "str preguntaPortugués1",
"options":
[
{
"textEN": "str opción1Inglés",
"textES": "str opción1Español",
"textPT": "str opción1Portugués"
},
{
"textEN": "str opción2Inglés",
"textES": "str opción2Español",
"textPT": "str opción2Portugués"
}, ...
],
"mandatory": bool value,
"filter_index": "str index",
"placeholderEN": "str placeholderInglés",
"placeholderES": "str placeholderEspañol",
"placeholderPT": "str placeholderPortugués"
},
"places": ["str placeId", "str placeId", ...],
"nationalities": ["str country", "str country", ...],
"min_age": int age,
"max_age": int age,
"min_hour": int hora,
"max_hour": int hora,
"gender": "str género",
"locale": "str LL",
"weekdays": ["str day", "str day", ...],
"start_date": "YYYY-MM-DDTHH:MM:SS.sssZ",
"end_date": "YYYY-MM-DDTHH:MM:SS.sssZ",
"label": "str etiqueta",
"is_registration": bool value,
"current_status": "str residencia",
"max_answers": int cantidad
}, ...
]
}
Datos de las research, con las preguntas y sus respuestas guardadas.
Para utilizar el endpoint es necesario reemplazar ":id" con el número de id asociado al Perfilamiento o Insight que se quiera consultar.
GET /api/v3/gather/:id/metrics
Status: 200
{
'message': 'Busqueda encontrada exitosamente',
'data':
[
{'1995/1/4': 5,
'1983/7/28': 3,
'1963/4/4': 2,
'1990-05-05T00:00:00.000Z': 1,
'1978/5/2': 2,
...
}
]
}
Cantidad de respuestas acumuladas en los research
Para utilizar el endpoint es necesario reemplazar ":id" con el número de id asociado al Perfilamiento o Insight que se quiera consultar.
GET /api/v3/gather/:id/responses/count
Status: 200
{
'message': 'Busqueda encontrada exitosamente',
'amount': 'str cantidadRespuestas'
}
Cantidad de Perfilamientos e Insights asociados a su cuenta
GET /api/v3/gather/count
Status: 200
{
'message': 'Busqueda encontrada exitosamente',
'data': 'str cantidadResearchs'
}
Todos los datos que son accesibles desde la plataforma, en la sección de Redes que tiene el usuario, serán accesibles desde la API a través de las siguientes rutas.
Para algunos de los endpoints se puede especificar una red en particular, la cual se puede elegir con un place_id, este es el número identificador de cada una de sus redes, el cual lo puede encontrar en el endpoint asociado a Información de Redes, en el campo de "id"
Cada una de las posibilidades ofrecidas por la lista de parámetros disponibles se usan directamente con el endpoint o se usan con la sintaxis mostrada a un costado
GET endpoint?parámetro1=valor1
GET endpoint?parámetro1=valor1&parámetro2=valor2&parámetro3=valor3 ...
Obtener la información de todas sus redes, con sus id's y nombres.
GET /api/v3/place/names
Status: 200
{
'message': 'nombres enviados exitosamente',
'data':
[
{
'id': int placeId,
'name': 'str placeName'
}, ...
]
}
Cantidad de veces que se ha desplegado el portal en sus redes.
Parámetros posibles:
GET /api/v3/place/displays/count
Status: 200
{
'message': 'Despliegues totales.',
'data': int cantidadDespliegues
}
Cantidad de despliegues del portal, detallado por fecha.
Parámetros posibles:
GET /api/v3/place/displays/by/day
Status: 200
{
'message': 'Despliegues de portal por dia',
'data':
[
["YYYY-MM-DD", "str cantidadDespliegues1"],
["YYYY-MM-DD", "str cantidadDespliegues2"], ...
]
}
Cantidad de despliegues del portal, detallado en cada hora del día.
Parámetros posibles:
GET /api/v3/place/displays/by/hour
Status: 200
{
'message': 'Despliegues de portal por hora',
'data':
[
[0, int cantidadDespliegues],[1, int cantidadDespliegues], ...
[22, int cantidadDespliegues], [23, int cantidadDespliegues]
]
}
Cantidad de usuarios a los cuales se les muestra el portal, detallado por la cantidad de ocurrencias.
Para utilizar el endpoint es necesario reemplazar ":place_id" con el número de id asociado a la red que se quiera consultar.
GET /api/v3/place/:place_id/displays/per/user
Status: 200
{
'message': 'Times portal displays per user',
'amount':
[
{'times_connected': '1', 'amount': int cantidad},
{'times_connected': '2', 'amount': int cantidad}, ...
{'times_connected': '10', 'amount': int cantidad},
{'times_connected': '+10', 'amount': int cantidad}
]
}
Cantidad de Conexiones en sus redes
Parámetros posibles:
GET /api/v3/place/connections/count
Status: 200
{
'message': 'Conexiones totales.',
'data': int cantidadConexiones
}
Cantidad de conexiones a las redes, detallado por fecha.
Parámetros posibles:
GET /api/v3/place/connections/by/day
Status: 200
{
'message': 'Conexiones de portal por dia',
'data':
[
['YYYY-MM-DD', 'str cantidadConexiones'],
['YYYY-MM-DD', 'str cantidadConexiones'], ...
]
}
Cantidad de conexiones a las redes, detallado por hora.
Parámetros posibles:
GET /api/v3/place/connections/by/hour
Status: 200
{
'message': 'Conexiones de portal por hora',
'data':
[
[0, int cantidadConexiones],[1, int cantidadConexiones], ...
[22, int cantidadConexiones], [23, int cantidadConexiones]
]
}
Cantidad de veces que los usuarios se conectan a las redes.
Para utilizar el endpoint es necesario reemplazar ":place_id" con el número de id asociado a la red que se quiera consultar.
GET /api/v3/place/:place_id/connections/per/user
Status: 200
{
'message': 'Times connected per user',
'amount':
[
{'times_connected': '1', 'amount': int cantidad},
{'times_connected': '2', 'amount': int cantidad}, ...
{'times_connected': '10', 'amount': int cantidad},
{'times_connected': '+10', 'amount': int cantidad}
]
}
Cantidad de personas a las que se les ha desplegado el portal, sin contar despliegues hechos para las mismas personas.
Parámetros posibles:
GET /api/v3/endusers/count/unique/per/day
Status: 200
{
'message': 'Busqueda encontrada exitosamente',
'data': 'str cantidadUsuarios'
}
Cantidad de usuarios nuevos, detallados por fechas
Parámetros posibles:
GET /api/v3/endusers/creation/per/day
Status: 200
{
'message': 'Busqueda encontrada exitosamente',
'data':
[
{
"date": "YYYY-MM-DD",
"count": int cantidadUsuarios
},
{
"date": "YYYY-MM-DD",
"count": int cantidadUsuarios
}, ...
]
}
Datos asociados a las preguntas de los usuarios
GET /api/v3/person/count
Status: 200
groupBy(gender/locale/nationality/current_status):
{
"message": "Personas contadas exitosamente",
"count":
[
{
"count": "str cantidadPersonas",
"filter": "str respuestaFilter"
}, ...
{
"count": "str cantidadPersonas",
"filter": null
}
]
}
groupBy(age):
{
"message": "Personas contadas exitosamente",
"count":
{
"gender1":
{
"str edad": int cantidadPersonas,
"str edad": int cantidadPersonas,
...
"str null": int cantidadPersonas
},
"gender2":
{
"str edad": int cantidadPersonas,
"str edad": int cantidadPersonas,
...
"str null": int cantidadPersonas
}, ...
}
}
Cantidad de dispositivos detectados en cada fecha en una red
Para utilizar el endpoint es necesario reemplazar ":id" con el número de id asociado a la red que se quiera consultar.
GET /api/v3/place/:id/detected/devices/by/day
Status: 200
{
'message': 'Dispositivos detectados por dia',
'data':
[
{
'id': int Id,
'date': 'YYYY-MM-DD',
'place_id': int placeId,
'amount': int cantidadDispositivos,
"created_at": "YYYY-MM-DDTHH:MM:SS.sssZ",
"updated_at": "YYYY-MM-DDTHH:MM:SS.sssZ",
"type": "str type"
}, ...
]
}
Cantidad de dispositivos detectados en una red en particular, filtrados por una métrica especifica.
Posibilidades para :metric:
Parámetros posibles:
GET /api/v3/place/detected/devices/:metric?place_id=:id
Status: 200
{
'message': 'Respuestas totales.',
'amount':
[
{
'metric': 'str metricType',
'count': int cantidadDispositivos
},
{
'metric': 'str metricType',
'count': int cantidadDispositivos
}, ...
]
}