Metrics

Métricas do TikTok Shop pela API

Seu cliente conecta a conta do TikTok Shop e seu produto consulta 34 métricas pelo mesmo endpoint das outras plataformas. Cada métrica tem um identificador (reference_key) que vai na chamada.

POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>

{
  "customer_integration": "<connection uuid>",
  "start": "2026-10-01",
  "end": "2026-10-31",
  "comparison_start": "2026-09-01",
  "comparison_end": "2026-09-30",
  "metrics": [
    {
      "id": "m1",
      "reference_key": "tiktok_shop:orders",
      "component": "number_v1",
      "metrics": [
        "orders"
      ]
    }
  ]
}
Exemplo: "Pedidos" em outubro, comparado a setembro.

Mais exemplos de chamadas no TikTok Shop

O mesmo endpoint para cada tipo de métrica. Os campos metrics e dimensions de cada item vêm do catálogo da plataforma (GET /api/metrics/{integration_slug}).

Gráfico

Pedidos ao longo do tempo

Pedidos feitos em cada dia do período analisado.

POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>

{
  "customer_integration": "<connection uuid>",
  "start": "2026-10-01",
  "end": "2026-10-31",
  "metrics": [
    {
      "id": "m1",
      "reference_key": "tiktok_shop:orders_over_time",
      "component": "chart_v1",
      "metrics": [
        "orders"
      ],
      "dimensions": [
        "date"
      ]
    }
  ]
}

Tabela

Resumo de vendas

Vendas dos pedidos feitos em cada dia do período analisado, líquidas dos reembolsos concluídos naquele dia.

POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>

{
  "customer_integration": "<connection uuid>",
  "start": "2026-10-01",
  "end": "2026-10-31",
  "metrics": [
    {
      "id": "m1",
      "reference_key": "tiktok_shop:sales_summary",
      "component": "datatable_v1",
      "metrics": [
        "orders",
        "items_sold",
        "gross_sales",
        "seller_discount",
        "platform_discount",
        "net_sales",
        "shipping",
        "taxes",
        "total_sales"
      ],
      "dimensions": [
        "date"
      ]
    }
  ]
}

Número

Pedidos entregues

Pedidos feitos no período analisado que foram entregues ao cliente ou concluídos.

POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>

{
  "customer_integration": "<connection uuid>",
  "start": "2026-10-01",
  "end": "2026-10-31",
  "metrics": [
    {
      "id": "m1",
      "reference_key": "tiktok_shop:delivered_orders",
      "component": "number_v1",
      "metrics": [
        "delivered_orders"
      ]
    }
  ]
}

Números

22 métricas

  • Pedidos

    Número de pedidos feitos no período analisado, excluindo pedidos não pagos, pedidos cancelados e pedidos de amostra enviados a criadores.

    tiktok_shop:orders
  • Pedidos entregues

    Pedidos feitos no período analisado que foram entregues ao cliente ou concluídos.

    tiktok_shop:delivered_orders
  • Pedidos cancelados

    Pedidos cujo cancelamento foi concluído no período analisado, independentemente de quando foram feitos.

    tiktok_shop:cancelled_orders
  • Itens vendidos

    Unidades vendidas nos pedidos feitos no período analisado.

    tiktok_shop:items_sold
  • Clientes

    Número de clientes distintos que fizeram pedidos no período analisado.

    tiktok_shop:customers
  • Vendas brutas

    Preço dos produtos antes dos descontos nos pedidos feitos no período analisado.

    tiktok_shop:gross_sales
  • Desconto do vendedor

    Descontos custeados pela loja nos pedidos feitos no período analisado.

    tiktok_shop:seller_discount
  • Desconto da plataforma

    Descontos custeados pelo TikTok Shop nos pedidos feitos no período analisado. Como são pagos pela plataforma, não são deduzidos das vendas da loja.

    tiktok_shop:platform_discount
  • Vendas líquidas

    Vendas brutas menos os descontos custeados pela loja e os reembolsos concluídos no período analisado.

    tiktok_shop:net_sales
  • Frete

    Valores de frete pagos pelos clientes nos pedidos feitos no período analisado.

    tiktok_shop:shipping
  • Impostos

    Impostos cobrados nos pedidos feitos no período analisado.

    tiktok_shop:taxes
  • Total de vendas

    Vendas líquidas mais o frete e os impostos cobrados nos pedidos feitos no período analisado. Pedidos cancelados nunca entram nas vendas, por isso os cancelamentos não são deduzidos.

    tiktok_shop:total_sales
  • Valor médio do pedido

    Valor dos produtos dos pedidos feitos no período analisado, antes de descontos e reembolsos, dividido pelo número de pedidos.

    tiktok_shop:average_order_value
  • Itens por pedido

    Itens vendidos divididos pelo número de pedidos feitos no período analisado.

    tiktok_shop:items_per_order
  • Valor dos cancelamentos

    Valor reembolsado aos clientes pelos cancelamentos concluídos no período analisado.

    tiktok_shop:cancelled_amount
  • Reembolsos

    Solicitações de devolução e reembolso concluídas com reembolso no período analisado, independentemente de quando o pedido foi feito.

    tiktok_shop:refunds
  • Itens reembolsados

    Unidades reembolsadas pelas devoluções concluídas no período analisado.

    tiktok_shop:refunded_items
  • Valor dos reembolsos

    Valor reembolsado aos clientes pelas devoluções concluídas no período analisado.

    tiktok_shop:refunded_amount
  • Taxa de cancelamento

    Pedidos cujo cancelamento foi concluído no período analisado divididos pelos pedidos feitos nele.

    tiktok_shop:cancellation_rate
  • Taxa de reembolso

    Devoluções concluídas com reembolso no período analisado divididas pelos pedidos feitos nele.

    tiktok_shop:refund_rate
  • Frete médio

    Valores de frete pagos pelos clientes divididos pelo número de pedidos feitos no período analisado.

    tiktok_shop:average_shipping
  • Desconto médio

    Descontos custeados pela loja divididos pelo número de pedidos feitos no período analisado.

    tiktok_shop:average_discount

Gráficos

5 métricas

  • Pedidos ao longo do tempo

    Pedidos feitos em cada dia do período analisado.

    tiktok_shop:orders_over_time
  • Vendas ao longo do tempo

    Total de vendas dos pedidos feitos em cada dia do período analisado.

    tiktok_shop:sales_over_time
  • Pedidos por situação

    Distribuição dos pedidos feitos no período analisado pela situação atual, incluindo pedidos não pagos e cancelados.

    tiktok_shop:orders_by_status
  • Cancelamentos por solicitante

    Distribuição dos cancelamentos concluídos no período analisado por quem os solicitou: o cliente, a loja, os operadores do TikTok Shop ou o sistema.

    tiktok_shop:cancellations_by_initiator
  • Devoluções por tipo

    Distribuição das devoluções concluídas no período analisado pela solução dada: apenas reembolso, devolução e reembolso, substituição ou troca.

    tiktok_shop:returns_by_type

Tabelas

7 métricas

  • Resumo de vendas

    Vendas dos pedidos feitos em cada dia do período analisado, líquidas dos reembolsos concluídos naquele dia.

    tiktok_shop:sales_summary
  • Cancelamentos e reembolsos por dia

    Cancelamentos e reembolsos concluídos em cada dia do período analisado.

    tiktok_shop:cancellations_and_refunds_by_day
  • Vendas por forma de pagamento

    Pedidos feitos no período analisado agrupados pela forma de pagamento escolhida pelo cliente.

    tiktok_shop:sales_by_payment_method
  • Produtos mais vendidos

    Produtos vendidos no período analisado; as vendas líquidas deduzem os reembolsos desses itens concluídos no período. Situação, variações e estoque refletem o catálogo no momento do relatório, não o período.

    tiktok_shop:best_selling_products
  • Vendas por variante

    Variantes de produto vendidas no período analisado; as vendas líquidas deduzem os reembolsos desses itens concluídos no período. Preço e estoque refletem o catálogo no momento do relatório, não o período.

    tiktok_shop:sales_by_variant
  • Cancelamentos por motivo

    Cancelamentos concluídos no período analisado agrupados pelo motivo informado.

    tiktok_shop:cancellations_by_reason
  • Devoluções por motivo

    Devoluções concluídas no período analisado agrupadas pelo motivo informado pelo cliente.

    tiktok_shop:returns_by_reason

Veja o Connect aplicado ao seu produto.

Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.