Get available reports for a campaign

GET

/campaign/{id}/available-reports

Retrieves a list of available reports that can be generated for a campaign.

Features:

Returns client-specific report configurations

Each report includes URL code, name, and generation parameters

Reports are configured per client in settings

Report Types May Include:

Allocation reports

Pricing reports

Store lists

Export formats

Custom client reports

Request

Authorization

API Key

Add parameter in header

Authorization

Example:

Authorization: ********************

Path Params

Responses

🟢200OK

application/json

Available reports retrieved successfully

Body

🟠404Not Found

🔴500Internal Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://prod.your-api-server.com/campaign/550e8400-e29b-41d4-a716-446655440000/available-reports' \
--header 'Authorization: <api-key>'

Response Example

200 - Example 1

[
    {
        "urlCode": "allocation-summary",
        "name": "Allocation Summary Report",
        "description": "Summary of campaign item allocations by store",
        "format": "csv"
    },
    {
        "urlCode": "pricing-breakdown",
        "name": "Pricing Breakdown",
        "description": "Detailed pricing information for all campaign items",
        "format": "xlsx"
    }
]

Modified at 2025-09-25 10:04:16

Get campaign statistics

Get campaign item pricing information