Skip to main content
POST

Autorizações

Authorization
string
header
obrigatório

JWT da plataforma ou API key mtk_live_... enviada no header Authorization

Cabeçalhos

X-Workspace-Id
string

Obrigatório quando usar JWT. Opcional quando usar API key (mtk_live_...)

Exemplo:

"69162064162b926ae607959b"

Corpo

application/json
project_id
string
obrigatório

ID do projeto (brand) no Metrito

Exemplo:

"69162064162b926ae607959b"

fields
string[]
obrigatório

Lista de métricas a consultar. Consulte GET /v3/fields para ver todas as opções.

Minimum array length: 1
Exemplo:
source
enum<string>

Plataforma de anúncios. Omita para consultar todas.

Opções disponíveis:
meta_ads,
google_ads,
tiktok_ads
Exemplo:

"meta_ads"

connection_ids
string[]

IDs de conexões específicas. Omita para usar todas as conexões do projeto.

time
object
filters
object[]

Filtros para restringir os dados retornados

order
object

Ordenação dos resultados. Ex: { "spend": "desc" }

Exemplo:
limit
integer

Limite de resultados

Intervalo obrigatório: 1 <= x <= 50000
Exemplo:

100

offset
integer

Offset para paginação

Intervalo obrigatório: x >= 0
metadata
object

Opções adicionais da query

Resposta

Dados retornados com sucesso

success
boolean
data
object[]

Resultados da query. Cada item contém as métricas solicitadas.

currency
string

Moeda dos valores monetários na resposta

Exemplo:

"BRL"

warnings
string[]

Avisos sobre a query (granularidade indisponível, dados parciais, etc.)