---
title: "Get a campaign report"
description: "Retrieve the report generated when the campaign was closed, with its branded assets."
canonical: https://www.charitips.com/docs/api-reference/get-campaign-report
---

# Get a campaign report

`GET /v1/campaigns/{campaignId}/reports`

Retrieve the report generated when the campaign was closed, with its branded assets. Empty until all its assets are generated.

**Authentication**: Bearer access token.

## Parameters

- `campaignId` (string, required)

## Response 200

- `reportId` (string, required)
- `type` (ReportType, required) One of `CAMPAIGN`, `ACCOUNT`.
- `status` (ReportStatus, required) One of `PENDING`, `SENT`.
- `startDate` (string (date-time))
- `endDate` (string (date-time))
- `accountId` (string, required)
- `campaignId` (string)
- `createdAt` (string (date-time), required)
- `updatedAt` (string (date-time), required)
- `assets` (AssetWithUrl[], required)
  - `assetId` (string, required)
  - `type` (AssetType, required) One of `REPORT_INTRO`, `REPORT_TOP_SDGS`, `REPORT_TOP_CHARITIES`, `REPORT_GLOBAL`, `REPORT_CHARITY_FIRST`, `REPORT_CHARITY_SECOND`, `REPORT_CHARITY_THIRD`, `REPORT_CHARITY_FOURTH`, `REPORT_CHARITY_FIFTH`, `REPORT_OUTRO`, `REPORT_VIDEO`, `REPORT_PDF`.
  - `colorScheme` (AssetColorScheme, required) One of `DEFAULT`, `CUSTOMER`.
  - `format` (AssetFormat, required) One of `STORY`, `FEED`.
  - `hideAmount` (boolean, required)
  - `fileRef` (string, required)
  - `accountId` (string, required)
  - `reportId` (string, required)
  - `createdAt` (string (date-time), required)
  - `updatedAt` (string (date-time), required)
  - `url` (string, required): Public url of the generated file.
- `donationsCSV` (string): Campaign reports only. CSV of the claimed donations, or of the cast votes for a DISTRIBUTION campaign.
- `commentsCSV` (string): Campaign reports only. CSV of the feedbacks left by the participants, null without any feedback.

## Errors

- 401 `Unauthorized`: The access token is missing, expired or invalid. Create a new one with your client id and secret, send it as `Authorization: Bearer <accessToken>`, then retry once. Sandbox tokens only work on api.sandbox.charitips.com. See https://www.charitips.com/docs/get-started/authentication.md.
- 403 `Account closed`: The account behind these credentials is closed: no token is issued and every call is refused, reads included. Contact Charitips to reopen it. See https://www.charitips.com/docs/api-reference/troubleshooting.md#calls-answer-403-account-not-active-account-not-validated-or-account-closed.
- 403 `Forbidden`: Your credentials cannot perform this action on this resource. An id from another account never answers 403: it is treated as unknown, with a 404 in the path or a 400 `Bad Request` in the body or the query. See https://www.charitips.com/docs/api-reference/errors.md.
- 404 `Not Found`: No resource with this id on your account and environment. An id that belongs to another account answers 404 too when it is in the path. Ids from the sandbox do not exist in production. See https://www.charitips.com/docs/get-started/sandbox.md.

## Example

```bash
curl -X GET https://api.sandbox.charitips.com/v1/campaigns/<campaignId>/reports \
  -H "Authorization: Bearer $CHARITIPS_TOKEN"
```

```javascript
const response = await fetch('https://api.sandbox.charitips.com/v1/campaigns/<campaignId>/reports', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.CHARITIPS_TOKEN}`,
  },
});
if (!response.ok) throw new Error(`${response.status} ${await response.text()}`);
const data = await response.json();
```

```python
import os, requests

response = requests.get(
    "https://api.sandbox.charitips.com/v1/campaigns/<campaignId>/reports",
    headers={"Authorization": f"Bearer {os.environ['CHARITIPS_TOKEN']}"},
)
response.raise_for_status()
data = response.json()
```

## Response example (200, placeholder values)

```json
{
  "reportId": "<reportId>",
  "type": "CAMPAIGN",
  "status": "PENDING",
  "startDate": "<startDate>",
  "endDate": "<endDate>",
  "accountId": "<accountId>",
  "campaignId": "<campaignId>",
  "createdAt": "<createdAt>"
}
```