Endpoint
βGET /v1/external/campaigns/
Required Headers
Authorization: Bearer <your_token>
Query Parameters
Parameter | Type | Description | Required | Default |
| String | Filter by campaign status: | No |
|
| String | Filter by app name | No | β |
| Date | Only include campaigns created after this date (format: DD-MM-YYYY) | No | β |
| Array[String] | Filter by ISO 3166-1 alpha-2 country codes | No | β |
| Number | Number of results to return | No |
|
| Number | Result offset for pagination | No |
|
Example Request
curl -X GET "https://your-api-url.com/external/v1/campaigns?status=Active&limit=5" \ -H "Authorization: Bearer YOUR_API_TOKEN"
Example Response
{
"data": [
{
"id": 10123,
"name": "Summer UA Boost",
"status": "Active",
"app_name": "GameXYZ",
"countries": ["US", "GB"],
"created_at": "2024-04-01T12:00:00Z",
"updated_at": "2024-05-03T14:15:00Z"
}
],
"totalResultsCount": 18,
"limit": 5,
"offset": 0
}
Validation Rules
appName
: No special characters, max 50 characterscreatedSince
: Must be inDD-MM-YYYY
formatcountries
: Must use valid ISO 3166-1 alpha-2 codesstatus
: Must be one ofAll
,Active
,Inactive
Error Examples
Code | Error | Message |
400 |
| Date format must be DD-MM-YYYY |
400 |
| Please use valid ISO 3166-1 country codes |
400 |
| Must be one of All, Active, or Inactive |
403 |
| You do not have permission to access this resource |