> For the complete documentation index, see [llms.txt](https://docs.sprinthub.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.sprinthub.com/en/topics/api/api-get-on-custom-reports.md).

# API - GET on Custom Reports

Using Custom Reports, you can access the data from these reports via API if you want to build them in an external system such as PowerBI, for example.

<figure><img src="https://684109703-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9FzUKkagBNy5uQ7AtGNa%2Fuploads%2FpiresZ4fi0OpvNc3yGzY%2FChatGPT%20Image%20Jun%2030%2C%202025%2C%2011_13_53%20AM.png?alt=media&amp;token=50e285c7-29bf-4d0a-aca0-c44a94915f8a" alt=""><figcaption></figcaption></figure>

Remember to create the[ **Custom Report**](https://docs.sprinthub.com/topicos/analisar/relatorios-e-dashboards-personalizados/relatorios-videos-tutoriais/relatorios-dashboards-e-graficos-personalizados-no-sprinthub) before!

Reports are not updated all the time, so to avoid consuming all your API calls per minute, try calling GET on the report at most 3 times a day.

**Call to obtain the report IDs:**

{% code fullWidth="false" %}

```http
GET /advancedreports?apitoken=your-api-token&i=instance
```

{% endcode %}

**Report call by ID:**

```http
GET /reportchart/{report_id}?apitoken=your-api-token&i=instance
```

**URL Parameters**

* `report_id` (required): report ID
* `apitoken` (required): API authentication token
* `i` (required): your instance

**Headers**

```http
Content-Type: application/json
```

### Status Codes

| Code | Description     | Details                               |
| ---- | --------------- | ------------------------------------- |
| 200  | Success         | The request was successful            |
| 400  | Invalid request | Check the parameters sent             |
| 401  | Unauthorized    | Invalid or expired token              |
| 403  | Forbidden       | No permission to access the resource  |
| 404  | Not found       | The requested resource does not exist |
| 500  | Internal error  | Server error, try again later         |

### Notes

* All dates must be sent in ISO 8601 format (YYYY-MM-DD)
* The authentication token must be sent in all requests
* Request limit: check your plan's limit.


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.sprinthub.com/en/topics/api/api-get-on-custom-reports.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.
