GET /analytics/recovery

Etapas e cobertura das recuperações implementadas. Contrato v1 · disponível em produção e homologação · operação getAnalyticsRecovery. Guia funcional · Índice · Schemas · Testar em sandbox.

Autenticação e efeito

Permissão: analytics:read. Sessão humana ou chave de servidor limitada ao proprietário e aos aplicativos autorizados. OAuth/MCP ainda não estão disponíveis. Uma chave de exemplo deve incluir somente esta permissão e as leituras necessárias ao seu fluxo, restrita a app_loja; emita-a na área autenticada de desenvolvedores.

Disponível em produção e homologação; sujeito às capacidades do app e à configuração do provedor. OAuth só será aceito após B1b. Campos desconhecidos rejeitados. Consulte os ADRs para regras semânticas além do JSON Schema.

Consulta não altera o recurso. Downloads revalidam autorização e têm prazo/estado conforme o guia.

Parâmetros

Nome	Local	Obrigatório	Tipo e restrições
appId	query	sim	AppId; {“type”:“string”,“maxLength”:200,“minLength”:1,“pattern”:“^[A-Za-z0-9][A-Za-z0-9._~-]*$”}
start	query	sim	AnalyticsInstant; {“type”:“string”,“format”:“date-time”,“pattern”:“T\d{2}:\d{2}:\d{2}(?:\.\d{1,3})?(?:[Zz]|[+-]\d{2}:\d{2})$”}
end	query	sim	AnalyticsInstant; {“type”:“string”,“format”:“date-time”,“pattern”:“T\d{2}:\d{2}:\d{2}(?:\.\d{1,3})?(?:[Zz]|[+-]\d{2}:\d{2})$”}
timezone	query	não	string; {“type”:“string”,“default”:“America/Sao_Paulo”,“maxLength”:100}
group	query	não	all / main / operational; {“enum”:[“all”,“main”,“operational”],“default”:“all”}
linkId	query	não	LinkId; {“type”:“string”,“maxLength”:500,“pattern”:“^[a-z0-9.-]+-(?:(?!-)[A-Za-z0-9._-])*-(?:(?!-)[A-Za-z0-9._-])+$”}
domain	query	não	Domain; {“type”:“string”,“maxLength”:253,“pattern”:“^(?:a-z0-9?\.)+a-z0-9?$”}
prefix	query	não	string; {“type”:“string”,“maxLength”:200}

Corpo e semântica

Sem corpo. Envie os parâmetros na URL e os headers indicados.

Omitir campos opcionais usa o default documentado ou preserva o valor em PATCH. null só é aceito nos campos cujo schema permite null, com efeito de limpar/desvincular indicado no guia. Arrays enviados substituem a coleção quando o endpoint define atualização completa; não implicam merge. Identificadores/owner/app de um recurso existente não são transferidos por PATCH. Herança de templates/UTMs segue o guia, sem alterar links anteriores por cópia automática.

cURL

AGILINK_API_KEY deve ficar no servidor. Os placeholders abaixo são fictícios. Preserve Idempotency-Key e payload ao repetir uma intenção após timeout.

curl --request GET 'https://api.staging.agilink.io/v1/analytics/recovery?appId=app_loja&start=2026-10-01T00%3A00%3A00Z&end=2026-10-02T00%3A00%3A00Z' \
  --header 'Authorization: Bearer <credencial>'

JavaScript / TypeScript

// Node.js 22+. Defina AGILINK_API_KEY no ambiente do servidor.
const response = await fetch('https://api.staging.agilink.io/v1/analytics/recovery?appId=app_loja&start=2026-10-01T00%3A00%3A00Z&end=2026-10-02T00%3A00%3A00Z', {
  method: 'GET',
  headers: {
  "Authorization": `Bearer ${process.env.AGILINK_API_KEY}`
},
  redirect: 'error', signal: AbortSignal.timeout(30000)
});
if (!response.ok) throw new Error('HTTP '+response.status+' requestId='+response.headers.get('X-Request-Id'));
const result = await response.json();
console.log(result);

Python

# Python 3.10+; pip install requests
import os
import requests
headers = {
  "Authorization": "Bearer " + os.environ["AGILINK_API_KEY"]
}
response = requests.request(
    'GET', 'https://api.staging.agilink.io/v1/analytics/recovery?appId=app_loja&start=2026-10-01T00%3A00%3A00Z&end=2026-10-02T00%3A00%3A00Z',
    headers=headers,
    timeout=30, allow_redirects=False)
if not 200 <= response.status_code < 300:
    raise RuntimeError(f'HTTP {response.status_code}; requestId={response.headers.get("X-Request-Id")}')
result = response.json()
print(result)

Response 200

Sucesso. Exemplo fictício.

Header	Significado	Exemplo
X-Request-Id	Identificador gerado pelo servidor, inclusive para falhas e replays.	conforme resposta
Cache-Control	Respostas administrativas não podem ser armazenadas.	no-store, no-transform

{
  "data": {
    "appId": "app_loja",
    "period": {
      "start": "2026-10-01T00:00:00Z",
      "end": "2026-10-02T00:00:00Z",
      "timezone": "America/Sao_Paulo",
      "startInclusive": true,
      "endExclusive": true
    },
    "filters": {
      "campaignId": null,
      "folderId": null,
      "tagId": null,
      "group": "all",
      "linkId": null,
      "domain": null,
      "prefix": null,
      "device": null,
      "source": null,
      "country": null,
      "eventType": "all"
    },
    "generatedAt": "2026-10-02T12:00:00Z",
    "coverage": {
      "source": "retained_recovery_tokens",
      "grouping": "current_link_group",
      "deletedLinks": "excluded",
      "historicalAggregates": "not_merged",
      "uniqueVisitors": "distinct_click_hash_estimate",
      "nativeTrust": "client_reported",
      "completenessGuaranteed": false,
      "limitations": [
        "Totais calculados das linhas disponíveis; agregados históricos não são somados.",
        "Abertura não comprova instalação."
      ]
    },
    "issuedTokens": 1,
    "stages": [
      {
        "stage": "recovered",
        "eventCount": 1,
        "tokens": 1
      }
    ]
  },
  "meta": {
    "requestId": "req_00000000000040008000000000000001"
  }
}

Campo	Tipo	Obrigatório	Significado e limites
data	AnalyticsRecovery	sim	Resultado tipado da operação.
data.appId	AppId	sim	Aplicativo proprietário; precisa estar autorizado.
data.period	AnalyticsPeriod	sim	Valor tipado; formato e restrições completos no schema abaixo.
data.period.start	AnalyticsInstant	sim	Valor tipado; formato e restrições completos no schema abaixo.
data.period.end	AnalyticsInstant	sim	Valor tipado; formato e restrições completos no schema abaixo.
data.period.timezone	string	sim	Valor tipado; formato e restrições completos no schema abaixo. Até 100 caracteres
data.period.startInclusive	objeto	sim	Valor tipado; formato e restrições completos no schema abaixo.
data.period.endExclusive	objeto	sim	Valor tipado; formato e restrições completos no schema abaixo.
data.filters	AnalyticsFilters	sim	Valor tipado; formato e restrições completos no schema abaixo.
data.filters.campaignId	string ou null	sim	Valor tipado; formato e restrições completos no schema abaixo.
data.filters.folderId	string ou null	sim	Valor tipado; formato e restrições completos no schema abaixo.
data.filters.tagId	string ou null	sim	Valor tipado; formato e restrições completos no schema abaixo.
data.filters.group	all / main / operational	sim	Grupo main/operational; diferente de pasta/campanha.
data.filters.linkId	LinkId ou null	sim	Identidade composta do link.
data.filters.domain	Domain ou null	sim	Hostname, sem protocolo ou caminho.
data.filters.prefix	string ou null	sim	Prefixo de caminho, sem barras.
data.filters.device	android / ios / desktop / unknown ou null	sim	Valor tipado; formato e restrições completos no schema abaixo.
data.filters.source	string ou null	sim	Valor tipado; formato e restrições completos no schema abaixo.
data.filters.country	string ou null	sim	Valor tipado; formato e restrições completos no schema abaixo.
data.filters.eventType	all / click / app_open / content_view / legacy_content_load	sim	Valor tipado; formato e restrições completos no schema abaixo.
data.generatedAt	string	sim	Valor tipado; formato e restrições completos no schema abaixo. date-time
data.coverage	AnalyticsCoverage	sim	Valor tipado; formato e restrições completos no schema abaixo.
data.coverage.source	event_rows / retained_recovery_tokens	sim	Valor tipado; formato e restrições completos no schema abaixo.
data.coverage.grouping	objeto	sim	Valor tipado; formato e restrições completos no schema abaixo.
data.coverage.deletedLinks	objeto	sim	Valor tipado; formato e restrições completos no schema abaixo.
data.coverage.historicalAggregates	objeto	sim	Valor tipado; formato e restrições completos no schema abaixo.
data.coverage.uniqueVisitors	objeto	sim	Valor tipado; formato e restrições completos no schema abaixo.
data.coverage.nativeTrust	objeto	sim	Valor tipado; formato e restrições completos no schema abaixo.
data.coverage.completenessGuaranteed	objeto	sim	Valor tipado; formato e restrições completos no schema abaixo.
data.coverage.limitations	array	sim	Valor tipado; formato e restrições completos no schema abaixo. Até 1000 itens
data.issuedTokens	integer	sim	Valor tipado; formato e restrições completos no schema abaixo. Mínimo 0; Máximo 9007199254740991
data.stages	array	sim	Valor tipado; formato e restrições completos no schema abaixo. Até 1000 itens
data.stages[].stage	page_presented / copied / store_choice / clip_preview / recovered	sim	Valor tipado; formato e restrições completos no schema abaixo.
data.stages[].eventCount	integer	sim	Valor tipado; formato e restrições completos no schema abaixo. Mínimo 0; Máximo 9007199254740991
data.stages[].tokens	integer	sim	Valor tipado; formato e restrições completos no schema abaixo. Mínimo 0; Máximo 9007199254740991
meta	Meta	sim	Correlação e informações da resposta.
meta.requestId	RequestId	sim	Identificador de correlação gerado pelo servidor.

Falhas, revisão e repetição

Respeite Retry-After quando existir. Leituras podem ser repetidas após falhas transitórias. Não faça retry automático ilimitado.

Status	Significado
400	Cabeçalho, query, cursor ou JSON inválido.
401	Credencial inválida, expirada ou revogada.
403	Operação sem permissão ou capacidade desabilitada.
404	Recurso inexistente ou fora dos aplicativos autorizados.
422	JSON bem formado com dados de domínio inválidos.
429	Quota excedida. Respeitar Retry-After.
500	Falha interna. Use requestId para diagnóstico.
503	Dependência indisponível; resultado da mutação pode ser incerto.

Exemplo 401

{
  "error": {
    "code": "unauthenticated",
    "message": "Credencial inválida, expirada ou revogada.",
    "requestId": "req_00000000000040008000000000000001",
    "documentationUrl": "https://docs.agilink.io/api/errors/#unauthenticated"
  }
}

Exemplo 403

{
  "error": {
    "code": "insufficient_permission",
    "message": "Operação sem permissão ou capacidade desabilitada.",
    "requestId": "req_00000000000040008000000000000001",
    "documentationUrl": "https://docs.agilink.io/api/errors/#insufficient-permission"
  }
}

Exemplo 429

{
  "error": {
    "code": "rate_limited",
    "message": "Quota excedida. Respeitar Retry-After.",
    "requestId": "req_00000000000040008000000000000001",
    "documentationUrl": "https://docs.agilink.io/api/errors/#rate-limited"
  }
}

Schema completo e próximos passos

Schema de request

{
  "description": "Sem corpo"
}

Schema de response

{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "data": {
      "$ref": "#/components/schemas/AnalyticsRecovery"
    },
    "meta": {
      "$ref": "#/components/schemas/Meta"
    }
  },
  "required": [
    "data",
    "meta"
  ]
}

Convenções e limites · Erros · Receitas completas · Guia funcional.