Get campaign results grouped by contact. Provides a summary of all touchpoints for each contact in the campaign.

GET

https://host.com/v1/campaigns/:id/contacts/results

GET

/v1/campaigns/:id/contacts/results

1 const url = 'https://host.com/v1/campaigns/id/contacts/results';
2 const options = {
3   method: 'GET',
4   headers: {'X-API-Key': '<apiKey>', 'Content-Type': 'application/json'},
5   body: '{}'
6 };
7 
8 try {
9   const response = await fetch(url, options);
10   const data = await response.json();
11   console.log(data);
12 } catch (error) {
13   console.error(error);
14 }

200Retrieved

1 {
2   "data": [
3     {
4       "assignmentId": "string",
5       "assignmentStatus": "string",
6       "contactId": "string",
7       "firstName": "string",
8       "lastName": "string",
9       "touchpoints": [
10         {
11           "touchpointId": "string",
12           "type": "phone",
13           "phone": "string",
14           "message": "string",
15           "conversationId": "string",
16           "outcome": "string",
17           "publishedAt": "2024-01-15T09:30:00Z",
18           "finishedAt": "2024-01-15T09:30:00Z",
19           "additionalData": {},
20           "errorMessage": "string"
21         }
22       ]
23     }
24   ],
25   "total": 1,
26   "page": 1,
27   "size": 1,
28   "pages": 1
29 }

Authentication

X-API-Keystring

API Key authentication. Generate your API key in the Gail Portal under General > Integrations > API Keys.

Path parameters

idstringRequiredformat: "uuid"

The unique identifier of the campaign.

Query parameters

afterstringOptionalformat: "uuid"

A GUID cursor to fetch items strictly after this ID.

beforestringOptionalformat: "uuid"

A GUID cursor to fetch items strictly before this ID.

limitintegerOptionalDefaults to 50

Maximum number of items to retrieve (default 50).

pageintegerOptionalDefaults to 1Deprecated

The page number (1-based).

sizeintegerOptionalDefaults to 50Deprecated

Number of items per page (default 50).

Request

Pagination parameters.

Response

datalist of objects or nullOptional

totalinteger or nullOptional

pageinteger or nullOptional

sizeinteger or nullOptional

pagesinteger or nullOptional