Visualizaciones

1. Listar visualizaciones

Devuelve una lista de todas las visualizaciones.

• URL: /lighthouse/orgs/{org_id}/businesses/{business_id}/workspaces/{workspace_id}/views

• Método: GET

• Descripción: Recupera una lista no paginada de visualizaciones.

Query Params

Nombre	Tipo	Obligatorio	Descripción

Ejemplo de Solicitud

curl -X GET https://api.piercloud.io/lighthouse/orgs/{org_id}/businesses/{business_id}/workspaces/{workspace_id}/views \
     -H "Authorization: Bearer "

Respuesta Exitosa (200 OK)

{
  "code": "success",
  "data": {
    "views": [
      {
        "id": 1,
        "name": "Nombre de la visualización",
        "description": null,
        "created_at": "2025-01-01T00:00:00.911Z"
      }
    ],
    "total": 1
  }
}

Respuesta de Error (400 Bad Request)

{
  "code": "bad-request/invalid-parameters",
  "message": "mensaje de error"
}

Respuesta de Error (401 Unauthorized)

{
  "code": "failed",
  "message": "token inválido o expirado"
}

Respuesta de Error (403 Forbidden)

{
  "code": "authorization/forbidden",
  "message": "No se puede dar acceso al usuario"
}

---

2. Acceder a la información de la visualización

Devuelve la información de una visualización específica.

• URL: /lighthouse/orgs/{org_id}/businesses/{business_id}/views/{id}

• Método: GET

• Descripción: Devuelve información de una sola visualización.

Query Params

Nombre	Tipo	Obligatorio	Descripción

Ejemplo de Solicitud

curl -X GET https://api.piercloud.io/lighthouse/orgs/{org_id}/businesses/{business_id}/views/{id} \
     -H "Authorization: Bearer "

Respuesta Exitosa (200 OK)

{
  "code": "success",
  "data": {
    "id": 123,
    "name": "Nombre de la visualización",
    "description": null,
    "workspace": {
      "id": 1234,
      "name": "Nombre del espacio de trabajo"
    }
  }
}

Respuesta de Error (400 Bad Request)

{
  "code": "bad-request/invalid-parameters",
  "message": "mensaje de error"
}

Respuesta de Error (401 Unauthorized)

{
  "code": "failed",
  "message": "token inválido o expirado"
}

Respuesta de Error (403 Forbidden)

{
  "code": "authorization/forbidden",
  "message": "No se puede dar acceso al usuario"
}

Respuesta de Error (404 Not Found)

{
  "code": "view/not-found",
  "message": "Visualización no encontrada"
}

---

3. Obtener datos de la visualización

• URL: /lighthouse/orgs/{org_id}/businesses/{business_id}/views/{id}/data

• Método: GET

• Descripción: Retorna el token de acceso y demás información a partir de las credenciales proporcionadas.

Query Params

Nombre	Tipo	Obligatorio	Descripción
start_date	ISO-8601	No	Fecha inicial del período (YYYY-MM-DD). Por defecto: inicio del mes actual
end_date	ISO-8601	No	Fecha final del período (YYYY-MM-DD). Por defecto: fin del mes actual
date_type	string	No	Indique "month" si desea filtrar agrupando por competencia, o "date" si desea filtrar por una fecha específica.
filters	JSON	No	Indique los filtros que desea agregar a la visualización, siguiendo el formato JSON según el ejemplo de filtros que se muestra a continuación.

Ejemplo de JSON de filtros

[
    {
        "name": "lineitem/usageaccountid",
        "data_type": "string",
        "role": "filter",
        "filters": [
            {
                "expression": "IS",
                "value": ["12345678901"],
                "negative_expression": false
            }
        ]
    }
]

columna	Tipo	Obligatorio	Descripción
name	string	Yes	Nombre de la columna que desea filtrar
data_type	string	Yes	Indique el tipo de columna. Valores posibles: "string", "number" y "date".
role	string	Yes	Indique el tipo de regla. Valor posible: "filter".
filters.expression	string	Yes	Indique la expresión de filtro. Valores posibles: "IS", "CONTAINS".
filters.value	Array<string>	Yes	Indique los valores por los que desea filtrar.
filters.negative_expression	Boolean	No	Indique si desea aplicar una expresión de negación.

Ejemplo de Solicitud

curl -X GET https://api.piercloud.io/lighthouse/orgs/{org_id}/businesses/{business_id}/views/{id}/data \
     -H "Authorization: Bearer "

Respuesta Exitosa (200 OK)

{
    "code": "success",
    "data": [
        {
            "key_1": "value_1",
            "key_2": "value_2",
            "key_3": "value_3"
            ...
        }
    ]
}

Respuesta de Error (400 Bad Request)

{
  "code": "bad-request/invalid-parameters",
  "message": "mensaje de error"
}

Respuesta de Error (401 Unauthorized)

{
  "code": "failed",
  "message": "token inválido o expirado"
}

Respuesta de Error (403 Forbidden)

{
  "code": "authorization/forbidden",
  "message": "No se puede dar acceso al usuario"
}

Respuesta de Error (404 Not Found)

{
  "code": "view/not-found",
  "message": "Visualización no encontrada"
}