Skip to main content

Get Campaigns

Retrieve a list of campaigns using filters like status, app, or country.

L
Written by Lior Avidar
Updated over a week ago

Endpoint

​GET /v1/external/campaigns/

Required Headers

Authorization: Bearer <your_token>

Query Parameters

Parameter

Type

Description

Required

Default

status

String

Filter by campaign status: All, Active, Inactive

No

All

appName

String

Filter by app name

No

β€”

createdSince

Date

Only include campaigns created after this date (format: DD-MM-YYYY)

No

β€”

countries

Array[String]

Filter by ISO 3166-1 alpha-2 country codes

No

β€”

limit

Number

Number of results to return

No

10

offset

Number

Result offset for pagination

No

0

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 characters

  • createdSince: Must be in DD-MM-YYYY format

  • countries: Must use valid ISO 3166-1 alpha-2 codes

  • status: Must be one of All, Active, Inactive

Error Examples

Code

Error

Message

400

invalid createdSince

Date format must be DD-MM-YYYY

400

invalid countries

Please use valid ISO 3166-1 country codes

400

invalid status

Must be one of All, Active, or Inactive

403

unauthorized

You do not have permission to access this resource

Did this answer your question?