Get campaign
Fetch a single campaign by ID.
Returns a single campaign by ID.
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | 24-character hexadecimal campaign ID |
Example request
GET https://api.auravisionlabs.com/v1/campaign/64a1b2c3d4e5f6a7b8c9d0e7
Authorization: Bearer <your_token>Example response
{
"id": "64a1b2c3d4e5f6a7b8c9d0e7",
"organisationId": "64a1b2c3d4e5f6a7b8c9d0e2",
"name": "Summer Promotion",
"description": "Q2 promotional test",
"ownerId": "12345",
"ownerEmail": "user@example.com",
"ownerName": "Jane Smith",
"lastUpdatedById": "12345",
"lastUpdatedByEmail": "user@example.com",
"lastUpdatedByName": "Jane Smith",
"metric": { "key": "entries", "display": "Entries", "type": "count", "unitType": "visitors" },
"campaignUplift": 0.1,
"taxonomies": [],
"lineTaxonomies": [],
"testLocations": ["64a1b2c3d4e5f6a7b8c9d0e3"],
"controlLocations": [],
"testPeriod": {
"selectedPreset": "custom",
"selectedDates": { "start": "2024-06-01T00:00:00.000Z", "end": "2024-06-30T23:59:59.999Z" }
},
"controlPeriod": {
"selectedPreset": "custom",
"selectedDates": { "start": "2024-05-01T00:00:00.000Z", "end": "2024-05-31T23:59:59.999Z" },
"active": true
},
"selectedBreakdowns": [{ "key": "genders", "values": ["male", "female"] }],
"testLocationsExcluded": false,
"controlLocationsExcluded": false,
"created": "2024-04-15T10:30:00.000Z",
"updatedAt": "2024-04-15T10:30:00.000Z"
}