Visualizações

1. Listar visualizações

Retorna uma lista de todas as visualizações.

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

• Método: GET

• Descrição: Recupera uma lista não paginada de visualizações.

Query Params

Nome	Tipo	Obrigatório	Descrição

Exemplo de Requisição

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

Resposta de Sucesso (200 OK)

{
  "code": "success",
  "data": {
    "views": [
      {
        "id": 1,
        "name": "Nome da visualização",
        "description": null,
        "created_at": "2025-01-01T00:00:00.911Z"
      }
    ],
    "total": 1
  }
}

Resposta de Erro (400 Bad Request)

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

Resposta de Erro (401 Unauthorized)

{
  "code": "failed",
  "message": "invalid or expired token"
}

Resposta de Erro (403 Forbidden)

{
  "code": "authorization/forbidden",
  "message": "Unable to give access to the user"
}

---

2. Acessar informações de visualização

Retorna as informações de uma visualização especifica.

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

• Método: GET

• Descrição: Retorna informações de uma única visualização.

Query Params

Nome	Tipo	Obrigatório	Descrição

Exemplo de Requisição

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

Resposta de Sucesso (200 OK)

{
  "code": "success",
  "data": {
    "id": 123,
    "name": "Nome da visualização",
    "description": null,
    "workspace": {
      "id": 1234,
      "name": "Nome do workspace"
    }
  }
}

Resposta de Erro (400 Bad Request)

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

Resposta de Erro (401 Unauthorized)

{
  "code": "failed",
  "message": "invalid or expired token"
}

Resposta de Erro (403 Forbidden)

{
  "code": "authorization/forbidden",
  "message": "Unable to give access to the user"
}

Resposta de Erro (404 Not Found)

{
  "code": "view/not-found",
  "message": "View not found"
}

---

3. Obter dados da visualização

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

• Método: GET

• Descrição: Retorna o token de acesso e demais informações à partir da credenciais fornecidas.

Query Params

Nome	Tipo	Obrigatório	Descrição
start_date	date	Não	Data inicial do período (YYYY-MM-DD). Padrão: início do mês corrente
end_date	date	Não	Data final do período (YYYY-MM-DD). Padrão: final do mês corrente
date_type	string	Não	Informe "month" caso queira fazer o filtro agrupado por competência, ou "date" caso queira fazer o filtro por data específica.
filters	JSON	Não	Informe os filtros que deseja adicionar na visualização, siga o padrão de JSON de acordo com exemplo abaixo de filtros.

Exemplo de JSON de filtros

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

Column	Tipo	Obrigatório	Descrição
name	string	Sim	Nome da coluna que deja realizar o filtro
data_type	string	Sim	Informe o tipo da coluna. Valores possíveis: "string", "number" e "date"
role	string	Sim	Informe o tipo de regra. Valor possível "filter"
filters.expression	string	Sim	Informe a expressão de filtro. Valores possíveis: "IS", "CONTAINS"
filters.value	Array<string>	Sim	Informe os valores que deseja realizar os filtros
filters.negative_expression	Boolean	Não	Informe se deseja realizar uma expressão de negação.

Exemplo de Requisição

curl -X GET 'https://api.piercloud.io/lighthouse/orgs/{org_id}/businesses/{business_id}/views/{view_id}/data?start_date=2025-09-01&end_date=2025-09-30&filters=[{"name": "lineitem/usageaccountid", "data_type": "string", "role": "filter", "filters": [{"expression": "IS","value": ["12345678901"],"negative_expression": false}]}]&date_type=date' \
     -H "Authorization: Bearer <access_token>"

Resposta de Sucesso (200 OK)

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

Resposta de Erro (400 Bad Request)

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

Resposta de Erro (401 Unauthorized)

{
  "code": "failed",
  "message": "invalid or expired token"
}

Resposta de Erro (403 Forbidden)

{
  "code": "authorization/forbidden",
  "message": "Unable to give access to the user"
}

Resposta de Erro (404 Not Found)

{
  "code": "view/not-found",
  "message": "View not found"
}