Documentación del endpoint del recurso `DataSet`

La siguiente documentación describe cómo interactuar con el endpoint DataSet de la API de Datafaro, el cual provee acceso a la información de los conjuntos de datos definidos en la plataforma.

Endpoint

GET /api/v1/dataset/

Este endpoint se utiliza para obtener información sobre un DataSet específico o para recuperar una lista de todos los conjuntos de datos disponibles, con opciones para filtrar por indicador, área, institución y frecuencia.

Autenticación

El acceso requiere autenticación mediante Token Authentication. Los tokens válidos deben incluirse en el encabezado HTTP de la solicitud:

Authorization: Token YOUR_ACCESS_TOKEN

Parámetros de solicitud

Los usuarios pueden refinar su búsqueda con los siguientes parámetros:

dataset: ID del conjunto de datos específico.
indicator: ID del indicador para filtrar los conjuntos de datos relacionados.
area: Código de una área temática del indicador para filtrar conjuntos de datos pertinentes.
institution: Código de una institución para filtrar conjuntos de datos asociados.
freq: Frecuencia específica para filtrar los conjuntos de datos según su frecuencia de actualización.

Ejemplos de solicitud

Ejemplo de solicitud para un dataSet específico

curl -X GET "http://datafaro.adatar.do/api/v1/dataset/?dataset=specific_dataset_id" \
     -H "Authorization: Token YOUR_ACCESS_TOKEN"

Ejemplo de solicitud con filtros

curl -X GET "http://datafaro.adatar.do/api/v1/dataset/?indicator=specific_indicator_id&area=ECONREAL&institution=BCRD&freq=M" \
     -H "Authorization: Token YOUR_ACCESS_TOKEN"

Respuesta

La respuesta consiste en una representación en formato JSON del DataSet o lista de conjuntos de datos, incluyendo detalles como el nombre, descripción, estado, y fechas de actualización.

Ejemplo de respuesta

[
    {
        "id": "GDP_Q1_2023",
        "indicator": "GDP_GROWTH",
        "institution": "BCRD",
        "name": "PIB Primer Trimestre 2023",
        "description": "Producto Interno Bruto para el primer trimestre del año 2023.",
        "status": "A",
        "last_update": "2023-04-01",
        "next_update": "2023-07-01",
        "frequency": "Q",
        "interval": 1
    }
    // ... más conjuntos de datos si no se especifica un 'dataset'
]

Códigos de estado HTTP

200 OK: La solicitud fue exitosa y se devuelve la información de los conjuntos de datos.
401 Unauthorized: Falta token de acceso o es inválido.
404 Not Found: No se encontró el conjunto de datos, indicador, área o institución especificados.
404 Not Found: La frecuencia especificada no es válida.

Manejo de errores

Cuando un recurso solicitado no existe o hay un problema con los parámetros, la API proporciona un mensaje de error claro y un código de estado HTTP correspondiente.

Ejemplo de respuesta de error

{
    "error": "No existe un dataset con el id 'specific_dataset_id'"
}

Indicador Actualización (Dataset update)

Documentación del endpoint del recurso DataSet