Una variable es una unidad fundamental de datos que representa una métrica o indicador específico dentro del sistema VereData. Cada variable está asociada a una fuente de datos y tiene atributos que la describen y categorizan.
Endpoints
1. Listar variables
Obtiene el catálogo completo de variables disponibles en el sistema.
Endpoint: GET /v2/update/variables
Solicitud
curl -X GET \
'https://apivd.veredata.co/v2/update/variables' \
-H 'Authorization: Bearer $ACCESS_TOKEN' \
-H 'Content-Type: application/json'
Ejemplo de respuesta
[
{
"id": 1,
"table_db": {
"name": "Desaparición forzada",
"name_table": "desaparicion_forzada",
"category": "Conflicto armado",
"description": "Son eventos altamente...",
"entity": "URV",
"link_download": "https://www.datos.gov.co/Inclusi-n-Social-y-Reconciliaci-n/Cifras-de-V-ctimas-por-Hechos-Municipal/9qih-4vkc/about_data",
"created": "2023-09-21T20:58:53.350150Z",
"source_status_id": 1,
"date_last_update": "2024-04-30"
},
"name_var": "Desaparición Forzada",
"name_modelo": "VictimizantesModel",
"column_periodo": "periodo",
"type_search": "none_filter",
"add_division": true,
"type_division": "MUNICIPAL",
"is_geometry": false,
"column_select": "total",
"column_process": "sumatoria",
"columns_view": {},
"category": "conflicto_armado",
"is_multiple": false,
"is_previous_year": false,
"normalize": true,
"units": "Desapariciones",
"filter_model": {
"hecho": [
"Desaparición forzada"
]
},
"is_atributo": false,
"column_atributo": {},
"tag_state": ""
},
// ... más variables
]
Estructura del objeto variable
Cada variable en el sistema tiene los siguientes atributos:
-
id: Identificador único de la variable
-
table_db: Objeto que contiene información sobre la fuente asociada
-
name: Nombre descriptivo de la fuente
-
name_table: Nombre técnico de la fuente en el sistema
-
category: Categoría temática a la que pertenece la fuente
-
description: Descripción detallada de la fuente
-
entity: Entidad responsable de los datos
-
link_download: URL para descargar los datos
-
created: Fecha de creación de la fuente
-
source_status_id: ID del estado de la fuente de datos
-
date_last_update: Fecha de la última actualización
-
name_var: Nombre descriptivo de la variable
-
name_modelo: Nombre del modelo asociado a la variable
-
column_periodo: Nombre de la columna de período
-
type_search: Tipo de búsqueda permitida para la variable
-
add_division: Si se debe agregar una división a la variable
-
type_division: Tipo de división de la variable (veredal, municipal, departamental)
-
is_geometry: Si la variable tiene un componente de geometría
-
column_select: Nombre de la columna a seleccionar
-
column_process: Tipo de procesamiento a aplicar a la columna
-
columns_view: Columnas adicionales a mostrar
-
category: Categoría a la que pertenece la variable
-
is_multiple: Si la variable tiene múltiples valores
-
is_previous_year: Si la variable retorna los periodos anteriores al seleccionado
-
normalize: Si los datos de la variable se pueden obtener normalizados (por presencial municipal (true o false), por cada 100.000 habitantes a nivel municipal)
-
units: Unidad de la variable
-
filter_model: Objeto que contiene filtros para la variable
-
is_atributo: Si la variable es un atributo
-
column_atributo: Objeto que contiene información sobre la columna de atributo
-
tag_state: Etiqueta del estado de la variable (nueva, pronto, actualizandose)
2. Obtener valores únicos de un campo de una variable
Este endpoint permite obtener los valores únicos de un campo específico de una variable.
Endpoint: GET /v2/historic/filter?modelo=Acciones Subversivas&campo_filtro=conducta
Parámetros de consulta
modelo (requerido): Nombre de la variable (por ejemplo, Acciones Subversivas).campo_filtro (requerido): Nombre del campo del cual se desean obtener los valores únicos (por ejemplo, conducta).
Ejemplo de solicitud
curl -X GET \
'https://apivd.veredata.co/v2/historic/filter?modelo=Acciones%20Subversivas&campo_filtro=conducta' \
-H 'Authorization: Bearer $ACCESS_TOKEN' \
-H 'Content-Type: application/json'
Ejemplo de respuesta
[
{
"valor_filtro": "ASESINADO",
"unidad_medida": ""
},
{
"valor_filtro": "HERIDO",
"unidad_medida": ""
}
]
Descripción de la respuesta
valor_filtro: Valor único encontrado para el campo solicitado.unidad_medida: Unidad de medida asociada al valor (si aplica).
3. Descargar histórico de variable por división
Este endpoint permite recuperar la información de una variable a partir de un tipo de división geográfica, aplicando filtros personalizados.
Endpoint: POST /v1/historic/download
Ejemplo de solicitud
{
"model": "CapturadosContrabandoOtrosModel",
"table_db": "capturados_contrabando_otros",
"year": "2016",
"column_periodo": "periodo",
"type_search": "core_filter",
"filtros_user": {
"clausulas": {
"tipo_alta": {
"condicion": "IN",
"valores": ["Resolucion Traslado", "Boleta Detencion"]
},
"situacion_juridica": {
"condicion": "NOT IN",
"valores": [ "SI"]
},
"genero": {
"condicion": "IN",
"valores": [ "FEMENINO"]
}
}
},
"add_division": true,
"type_division": "MUNICIPAL",
"column_select":"meses_condena",
"column_process":"sumatoria"
}
Ejemplo de respuesta
{
"name_table": "capturados_contrabando_otros",
"name_column": "meses_condena",
"year_data": 2016,
"size_data": 1134,
"data": [
{
"id": 1045,
"codigo__dane": "05001",
"municipio__nombre": "MEDELLÍN",
"departamento__nombre": "ANTIOQUIA",
"municipio_id": 1045,
"meses_condena": 11269.0
},
{
"id": 590,
"codigo__dane": "11001",
"municipio__nombre": "BOGOTÁ.D.C.",
"departamento__nombre": "BOGOTÁ.D.C.",
"municipio_id": 590,
"meses_condena": 9746.0
}
]
}
Descripción de la respuesta
name_table: Nombre de la tabla consultada.name_column: Nombre de la columna seleccionada.year_data: Año de los datos consultados.size_data: Cantidad de registros devueltos.data: Lista de objetos con los resultados por división.
