Skip to main content
POST
Este es el endpoint central de Atlas. Regresa la observación más reciente de cada indicador para cada entidad geográfica que pidas. El resultado es una fila por combinación de entidad x indicador, con el valor, el periodo al que corresponde y el contexto de la entidad (nombre, tipo, entidad padre). Hay dos formas de hacer las consultas.
  • Por su indicator_id. Encuentra los IDs en el catálogo de indicadores.
  • Por el collection_id. Trae los resultados de todos los indicadores dentro de la colección. Puedes consultar el catálogo de las colecciones en colecciones.
Adicionalmente es necesario especificar para qué entidad geográfica se requiere la información.
  • geo_entity_ids recibe una lista explícita de entity_id.
  • geo_filter recibe todo un nivel geográfico dentro de una entidad padre, por ejemplo “todas las AGEBs de Michoacán” o “todos los códigos postales de Morelia”.
Manda siempre un filtro geográfico.

Autorizaciones

Authorization
string
header
requerido

Token de autenticación. Formato requerido: Token tu-token (la palabra Token, un espacio y tu token). Solicita tu token escribiendo a contacto@tukanmx.com.

Cuerpo

application/json

Al menos uno de indicator_ids o collection_ids es requerido. No se pueden combinar geo_entity_ids y geo_filter.

indicator_ids
integer[]

Lista de IDs de indicadores (máximo 20). Requerido si no se proporciona collection_ids.

Maximum array length: 20
Ejemplo:
collection_ids
integer[]

Lista de IDs de colecciones (máximo 5). Requerido si no se proporciona indicator_ids.

Maximum array length: 5
Ejemplo:
geo_entity_ids
integer[]

Filtrar por IDs de entidades geográficas. No combinar con geo_filter.

Ejemplo:
geo_filter
object

Filtro geográfico jerárquico. Devuelve todas las entidades del tipo indicado contenidas dentro de la entidad padre.

Respuesta

Observaciones obtenidas exitosamente

count
integer
results
object[]