Skip to main content
POST
Executar consulta

Autorizações

Authorization
string
header
obrigatório

OAuth2 Authorization Code flow

Parâmetros de consulta

expand
string

Comma-separated fields to expand (e.g., "dataset")

fields
string

Comma-separated optional response fields. Supports "summary.short", "summary.long", and "summary.mdx".

Corpo

application/json
dataset
string
obrigatório

Dataset slug to query

Exemplo:

"empresas"

params
object
obrigatório

Query parameters. Varies by dataset.

asOfDate
string

Logical reference date for the query (YYYY-MM-DD)

Exemplo:

"2024-01-31"

mock

Enable mock mode. Use true/"default" for default example, or specify example key (e.g., "outro_exemplo")

Exemplo:

true

requestId
string

Request ID

Exemplo:

"req_123"

targetDocument
string

Target document (CNPJ/CPF) for property mapping. Used when the query result does not contain the document identifier.

Exemplo:

"57778216000108"

cache
boolean
padrão:true

Reuse cached results within the dataset validity window when true or omitted. When false, reuse only results from the last 72 hours.

Exemplo:

true

parent
object

Parent dataset query reference. Child queries persist zero cost.

Resposta

Query results

object
enum<string>
obrigatório

Object type identifier

Opções disponíveis:
query
Exemplo:

"query"

status
enum<string>
obrigatório

Query execution status

Opções disponíveis:
success,
partial_success,
error,
pending
dataset
object
obrigatório

Dataset being queried (minimal reference)

asOfDate
string
obrigatório

Date for which data is queried

Exemplo:

"2025-11-21"

createdAt
string<date-time>
obrigatório

Query creation timestamp

Exemplo:

"2025-11-21T19:00:00.000Z"

isMock
boolean
obrigatório

Whether this is a mock query (testing mode)

Exemplo:

false

cacheStatus
enum<string>
obrigatório
Opções disponíveis:
hit,
miss
results
object[]
obrigatório

Query results. Each item follows the schema defined by the dataset being queried.

rawParams
object
obrigatório

Raw query parameters used for this query

id
string

Query execution ID

Exemplo:

"qry_abc123"

provider
object

Provider used for the query

createdBy
object

Principal who created this query

requestId
string
summary

Rendered query summary markdown or MDX when requested via ?fields=summary.short, summary.long, summary.mdx, and/or summary.mdx-list. Single format → string. Multiple formats → object { short, long, mdx, "mdx-list" }.

attempts
number
duration
number

Query duration in milliseconds

errorMessage
string
cost
number

Query cost in cents (0 for cached queries)

affectedCanonicalTargets
object[]

Canonical entity query targets impacted by this dataset execution.

rawResponseProvider
object[] | null

Raw provider response captured during query execution.

parent
object

Parent dataset query reference