> 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/reference-documentation/check-a-reports-api-availability.md).

# Check a Report's API Availability

Not every report on impact.com can be retrieved via API. API access is set individually for each report and can change over time, so the most reliable way is to check a report's current status. The steps below apply to both brands and partners.

{% hint style="success" %}
**Prerequisite:** You need an API access token to complete these steps. Learn how to [create an API access token](https://help.impact.com/other/reference-documentation/api-access-tokens/create-an-api-access-token.md), and read our tips on how to [Keep Your Access Tokens Secure](https://help.impact.com/other/reference-documentation/api-access-tokens/keep-your-access-tokens-secure.md).
{% endhint %}

## Get your API credentials

1. [Log in](https://help.impact.com/other/reference-documentation/log-in-to-your-impactcom-account.md) to your impact.com account.
2. From the top navigation bar, select ![](https://3964917321-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) **\[User profile] → Settings**.
3. Under *Technical*, select the API page for your account type:
   * Brand page: [**API**](https://app.impact.com/secure/advertiser/api/fr/api-access-tokens-ui.ihtml)
   * Partner page: [**API**](https://app.impact.com/secure/mediapartner/api/fr/api-access-tokens-ui.ihtml)
4. Select the card of the access token you want to use.
5. On the *Credentials* tab, copy your *Account SID* and *Auth Token* values. You’ll use these in the next step.

## List all reports available to your account

1. Open an API client, like [Postman](https://www.postman.com/).
   * Alternatively, use a command-line tool such as Terminal for macOS, or PowerShell for Windows.
2. Use your *List Reports* endpoint to get a list of all your reports:
   * Brand endpoint: [List all available reports](https://integrations.impact.com/brand-api-reference/reference/report-export/reports-legacy)
   * Partner endpoint: [List all available reports](https://integrations.impact.com/partner-api-reference/reference/reports/reports)
3. Replace the `<AccountSID>` and `<AuthToken>` placeholders with the values you copied.
   * The response shows all reports available to your account, including those that can’t be retrieved via API.

## Check API availability for a specific report

1. In the response, find the report you're interested in by scanning for its *Name or Id*.
2. Check the value in the report’s `ApiAccessible` field:
   * `true`: You can retrieve this report via API.
   * `false`: You can’t retrieve this report via API at this time. Learn how to download or schedule the report in the platform instead.
3. Here's an example response for a report available through the partner API:

   ```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/reference-documentation/check-a-reports-api-availability.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.
