Uso

Referência de Ponto de Extremidade de Uso

As APIs de uso fornecem um resumo do consumo da API REST e da atividade de erro da sua assinatura. Esses endpoints são úteis para monitorar integrações, rastrear o volume diário de chamadas e identificar tendências de erro ao longo do tempo.

Os dados de uso incluem uma contagem total de chamadas de API e um detalhamento por usuário. Os dados de erro incluem uma contagem total de erros e um detalhamento por código de erro.

As APIs de uso usam o mesmo método de autenticação que outras APIs REST do Marketo. Passe o token de acesso no cabeçalho Authorization: Bearer {accessToken}.

Pontos de acesso

Uso diário

Recupera o uso da API para o dia atual.

GET /rest/v1/stats/usage.json

{
   "requestId": "5f7f#17d7d8f2b6f",
   "success": true,
   "result": [
      {
         "date": "2015-10-17",
         "total": 1120,
         "users": [
            {
               "userId": "some.body@yahoo.com",
               "count": 200
            },
            {
               "userId": "some.body@marketo.com",
               "count": 200
            },
            {
               "userId": "some.body@gmail.com",
               "count": 720
            }
         ]
      }
   ]
}

Cada objeto na matriz result contém um dia de totais de uso e um detalhamento por usuário.

Uso dos últimos 7 dias

Recupera o uso da API nos últimos sete dias. Cada elemento na matriz result representa um dia.

GET /rest/v1/stats/usage/last7days.json

Erros diários

Recupera erros de API do dia atual.

GET /rest/v1/stats/errors.json

{
   "requestId": "5f7f#17d7d8f2b6f",
   "success": true,
   "result": [
      {
         "date": "2015-10-17",
         "total": 73,
         "errors": [
            {
               "errorCode": "604",
               "count": 1
            },
            {
               "errorCode": "609",
               "count": 56
            },
            {
               "errorCode": "610",
               "count": 16
            }
         ]
      }
   ]
}

Cada objeto na matriz result contém um dia de totais de erros e um detalhamento por código de erro.

Erros dos últimos 7 dias

Recupera erros da API dos últimos sete dias. Cada elemento na matriz result representa um dia.

GET /rest/v1/stats/errors/last7days.json

Membros de resposta

Objeto de resultado de uso

Objeto de usuário de uso

Objeto de resultado de erro

Objeto de erro

Observações

Cada um dos usuários da API é relatado individualmente na resposta de uso. Dividir as integrações entre usuários da API separados facilita a identificação de qual serviço está consumindo cota e produzindo erros.