tokeflow.com
DocumentaçãoReferência da APIDashboardsSDKsChangelog

Visão geral do dashboard da Organization

Leia as principais estatísticas da Organization — pedidos, taxas de aprovação e os principais Merchants entre todos os Merchants da Organization.

Esses endpoints somente leitura alimentam o dashboard inicial da Organization: números agregados de pedidos e receita, tendências de taxa de aprovação e rankings dos Merchants que geram mais volume.

Uma Organization abrange todos os Merchants que ela contém, então esses números são consolidados entre todos eles. Use-os para uma visão geral; aprofunde-se em um único Merchant através do dashboard do Merchant.

Esses endpoints alimentam a interface do Tokeflow Dashboard no nível da Organization. Eles são autenticados por sessão (JWT bearer) — o token vem do login no Dashboard, não de uma chave de API sk_/pk_. As solicitações também carregam o header x-organization-id, e o usuário autenticado deve ser membro dessa Organization.

O objeto de estatísticas do dashboard

Retornado pelos endpoints de listagem e busca desta página.

CampoTipoDescrição
total_ordersnumberTodos os pedidos na janela, incluindo tentativas rejeitadas. Este é o denominador de approval_rate e failure_rate.
successful_ordersnumberPedidos que atingiram autorização — authorized, refunded, partially_refunded, charged_back e refund_pending. Exclui tentativas failed e canceled, e pedidos ainda em andamento.
approval_ratenumberTaxa de aprovação como porcentagem (0-100).
failure_ratenumberTaxa de falha como porcentagem (0-100).
order_trendarrayDados de tendência de pedidos dos últimos 7 dias.
status_distributionarrayDistribuição de pedidos por status.
top_merchants_by_ordersarrayPrincipais Merchants por número de pedidos.
top_merchants_by_approvalarrayPrincipais Merchants por taxa de aprovação.

Endpoints

GET/api/v1/org/dashboard/routing-overview

Org

Auth: Dashboard session (JWT bearer). É necessário ser membro da Organization.

Obtém a visão geral de roteamento em todos os Merchants da Organization.

Parâmetros de consulta

CampoTipoObrigatórioDescrição
pagenumberNãoNúmero da página (indexado a partir de 1). Padrão 1, mín. 1.
limitnumberNãoNúmero de itens por página. Padrão 20, mín. 1, máx. 100.

Exemplo de solicitação

curl -G https://api.tokeflow.com/api/v1/org/dashboard/routing-overview \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9…" \
  -H "x-organization-id: org_4b21e7c3" \
  --data-urlencode "page=1" \
  --data-urlencode "limit=20"

GET/api/v1/org/dashboard/stats

Org

Auth: Dashboard session (JWT bearer). É necessário ser membro da Organization.

Obtém as estatísticas do dashboard da Organization.

Parâmetros de consulta

CampoTipoObrigatórioDescrição
date_fromstringNãoData de início das estatísticas (formato ISO 8601)
date_tostringNãoData de término das estatísticas (formato ISO 8601)

Exemplo de solicitação

curl -G https://api.tokeflow.com/api/v1/org/dashboard/stats \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9…" \
  -H "x-organization-id: org_4b21e7c3" \
  --data-urlencode "date_from=string" \
  --data-urlencode "date_to=string"

Exemplo de resposta — 200

{
  "total_orders": 42,
  "successful_orders": 1,
  "approval_rate": 92.4,
  "failure_rate": 92.4,
  "order_trend": [
    {
      "date": "string",
      "count": 42
    }
  ],
  "status_distribution": [
    {
      "status": "active",
      "count": 42,
      "percentage": 92.4
    }
  ],
  "top_merchants_by_orders": [
    {
      "merchant_id": "mrc_8a3f12d9",
      "merchant_name": "Acme Store",
      "order_count": 42
    }
  ],
  "top_merchants_by_approval": [
    {
      "merchant_id": "mrc_8a3f12d9",
      "merchant_name": "Acme Store",
      "approval_rate": 92.4,
      "total_orders": 42
    }
  ]
}

GET/api/v1/org/dashboard/top-merchants/by-approval-rate

Org

Auth: Dashboard session (JWT bearer). É necessário ser membro da Organization.

Principais Merchants por taxa de aprovação de pedidos da Organization.

Parâmetros de consulta

CampoTipoObrigatórioDescrição
date_fromstringNãoData de início (ISO 8601). Padrão: 30 dias atrás.
date_tostringNãoData de término (ISO 8601). Padrão: agora.
limitstringNãoQuantos Merchants retornar (padrão 5, máx. 50)
min_ordersstringNãoNúmero mínimo de pedidos para inclusão (padrão 10)

Exemplo de solicitação

curl -G https://api.tokeflow.com/api/v1/org/dashboard/top-merchants/by-approval-rate \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9…" \
  -H "x-organization-id: org_4b21e7c3" \
  --data-urlencode "date_from=string" \
  --data-urlencode "date_to=string" \
  --data-urlencode "limit=string" \
  --data-urlencode "min_orders=string"

Exemplo de resposta — 200

{
  "data": [
    {
      "merchant_id": "mrc_8a3f12d9",
      "merchant_name": "Acme Store",
      "approval_rate": 92.4,
      "total_orders": 42
    }
  ]
}

GET/api/v1/org/dashboard/top-merchants/by-orders

Org

Auth: Dashboard session (JWT bearer). É necessário ser membro da Organization.

Principais Merchants por número total de pedidos da Organization.

Parâmetros de consulta

CampoTipoObrigatórioDescrição
date_fromstringNãoData de início (ISO 8601). Padrão: 30 dias atrás.
date_tostringNãoData de término (ISO 8601). Padrão: agora.
limitstringNãoQuantos Merchants retornar (padrão 5, máx. 50)

Exemplo de solicitação

curl -G https://api.tokeflow.com/api/v1/org/dashboard/top-merchants/by-orders \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9…" \
  -H "x-organization-id: org_4b21e7c3" \
  --data-urlencode "date_from=string" \
  --data-urlencode "date_to=string" \
  --data-urlencode "limit=string"

Exemplo de resposta — 200

{
  "data": [
    {
      "merchant_id": "mrc_8a3f12d9",
      "merchant_name": "Acme Store",
      "order_count": 42
    }
  ]
}

Erros

Os erros usam o envelope padrão. Os casos mais comuns aqui:

HTTPSignificado
400Parâmetros inválidos ou um estado que não permite esta operação.
401Token de sessão do Dashboard ausente, expirado ou inválido.
403Autenticado, mas o usuário autenticado não tem acesso a esta entidade.
404O registro não existe ou não é visível para esta entidade.

Relacionados

Webhooks do Merchant

Anterior

Chaves de API da Organization

Próxima

Nesta página

O objeto de estatísticas do dashboardEndpointsGET /api/v1/org/dashboard/routing-overviewGET /api/v1/org/dashboard/statsGET /api/v1/org/dashboard/top-merchants/by-approval-rateGET /api/v1/org/dashboard/top-merchants/by-ordersErrosRelacionados