> For the complete documentation index, see [llms.txt](https://help.impact.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.impact.com/other/pt-br/reference-documentation/verificar-a-disponibilidade-da-api-de-um-relatorio.md).

# Verificar a disponibilidade da API de um relatório

Nem todos os relatórios do impact.com podem ser recuperados pela API. O acesso à API é definido individualmente para cada relatório e pode mudar com o tempo. Por isso, a maneira mais confiável é verificar o status atual do relatório. As etapas abaixo se aplicam tanto a marcas quanto a parceiros.

{% hint style="success" %}
**Pré-requisito:** Você precisa de um token de acesso à API para concluir estas etapas. Saiba como [criar um token de acesso à API](https://help.impact.com/other/pt-br/reference-documentation/api-access-tokens/create-an-api-access-token.md)e confira nossas dicas sobre como [manter seus tokens de acesso seguros](https://help.impact.com/other/pt-br/reference-documentation/api-access-tokens/keep-your-access-tokens-secure.md).
{% endhint %}

## Obter suas credenciais da API

1. [Faça login](https://help.impact.com/other/pt-br/reference-documentation/log-in-to-your-impactcom-account.md) na sua conta do impact.com.
2. Na barra de navegação superior, selecione ![](https://1897586174-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhRN1rcrim887TwHLBjac%2Fuploads%2Fpmc2UIFakEHRS3pas1a0%2Fprofile.svg?alt=media\&token=87284fd9-5037-4062-ad5d-234b845664f5) **\[Perfil do usuário] → Configurações**.
3. Em *Técnico*, selecione a página da API correspondente ao tipo da sua conta:
   * Página da marca: [**API**](https://app.impact.com/secure/advertiser/api/fr/api-access-tokens-ui.ihtml)
   * Página do parceiro: [**API**](https://app.impact.com/secure/mediapartner/api/fr/api-access-tokens-ui.ihtml)
4. Selecione o cartão do token de acesso que deseja usar.
5. Na guia *Credenciais* , copie os valores de *Account SID* e *Auth Token* . Você usará esses valores na próxima etapa.

## Listar todos os relatórios disponíveis para sua conta

1. Abra um cliente de API, como o [Postman](https://www.postman.com/).
   * Como alternativa, use uma ferramenta de linha de comando, como o Terminal no macOS ou o PowerShell no Windows.
2. Use o endpoint *List Reports* para obter uma lista de todos os seus relatórios:
   * Endpoint da marca: [Listar todos os relatórios disponíveis](https://integrations.impact.com/brand-api-reference/reference/report-export/reports-legacy)
   * Endpoint do parceiro: [Listar todos os relatórios disponíveis](https://integrations.impact.com/partner-api-reference/reference/reports/reports)
3. Substitua os espaços reservados `<AccountSID>` e `<AuthToken>` pelos valores que você copiou.
   * A resposta mostra todos os relatórios disponíveis para sua conta, incluindo aqueles que não podem ser recuperados pela API.

## Verificar a disponibilidade da API para um relatório específico

1. Na resposta, localize o relatório desejado procurando por *Name ou Id*.
2. Verifique o valor no campo `ApiAccessible` do relatório:
   * `true`: Você pode obter este relatório pela API.
   * `false`: No momento, não é possível obter este relatório pela API. Saiba como baixar ou agendar o relatório na plataforma.
3. Veja um exemplo de resposta para um relatório disponível pela API de parceiros:

   ```json
   {
     "Reports": [
       {
         "Name": "Action Listing",
         "Id": "ps_a_action_listing",
         "Category": "Performance",
         "Description": "Lists all actions for a date range.",
         "ApiAccessible": true,
         "ApiRunUri": "/Mediapartners/<AccountSID>/Reports/ps_a_action_listing",
         "DeferredApiRunUri": "/Mediapartners/<AccountSID>/ReportExport/ps_a_action_listing",
         "MetaDataUri": "/Mediapartners/<AccountSID>/ReportsMetadata/ps_a_action_listing"
       }
     ]
   }
   ```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://help.impact.com/other/pt-br/reference-documentation/verificar-a-disponibilidade-da-api-de-um-relatorio.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
