curl --request GET \
--url https://api.wapikit.com/api/campaigns \
--header 'x-access-token: <api-key>'{
"campaigns": [
{
"uniqueId": "<string>",
"name": "<string>",
"status": "Draft",
"createdAt": "2023-11-07T05:31:56Z",
"lists": [
{
"name": "<string>",
"description": "<string>",
"numberOfContacts": 123,
"numberOfCampaignsSent": 123,
"tags": [
{
"label": "<string>",
"uniqueId": "<string>"
}
],
"uniqueId": "<string>",
"createdAt": "2023-11-07T05:31:56Z"
}
],
"isLinkTrackingEnabled": true,
"tags": [
{
"label": "<string>",
"uniqueId": "<string>"
}
],
"description": "<string>",
"organizationId": "<string>",
"sentAt": "2023-11-07T05:31:56Z",
"scheduledAt": "2023-11-07T05:31:56Z",
"templateMessageId": "<string>",
"phoneNumberInUse": "<string>",
"templateComponentParameters": {
"header": [
{
"nameOrIndex": "<string>",
"label": "<string>",
"parameterType": "static",
"dynamicField": "<string>",
"staticValue": "<string>",
"example": "<string>",
"placeholder": "<string>"
}
],
"body": [
{
"nameOrIndex": "<string>",
"label": "<string>",
"parameterType": "static",
"dynamicField": "<string>",
"staticValue": "<string>",
"example": "<string>",
"placeholder": "<string>"
}
],
"buttons": [
{
"nameOrIndex": "<string>",
"label": "<string>",
"parameterType": "static",
"dynamicField": "<string>",
"staticValue": "<string>",
"example": "<string>",
"placeholder": "<string>"
}
],
"productSections": [
{
"title": "<string>",
"productItems": [
{
"productRetailerId": "<string>"
}
]
}
],
"catalogId": "<string>",
"productRetailerId": "<string>"
},
"stats": {
"totalRecipients": 123,
"messagesSent": 123,
"messagesFailed": 123,
"messagesDelivered": 123,
"messagesUndelivered": 123,
"messagesRead": 123,
"totalMessages": 123,
"conversationInitiated": 123,
"responseRate": 123,
"openRate": 123,
"engagementRate": 123,
"totalLinkClicks": 123,
"engagementTrends": [
{
"date": "2023-11-07T05:31:56Z",
"label": "<string>",
"count": 123
}
],
"linkClicksData": [
{
"date": "2023-11-07T05:31:56Z",
"label": "<string>",
"count": 123
}
],
"messageAnalytics": [
{
"date": "2023-11-07T05:31:56Z",
"label": "<string>",
"sent": 123,
"delivered": 123,
"replied": 123,
"read": 123
}
]
},
"progress": {
"totalMessages": 123,
"sent": 123
}
}
],
"paginationMeta": {
"page": 123,
"per_page": 123,
"total": 123
}
}returns all campaigns.
curl --request GET \
--url https://api.wapikit.com/api/campaigns \
--header 'x-access-token: <api-key>'{
"campaigns": [
{
"uniqueId": "<string>",
"name": "<string>",
"status": "Draft",
"createdAt": "2023-11-07T05:31:56Z",
"lists": [
{
"name": "<string>",
"description": "<string>",
"numberOfContacts": 123,
"numberOfCampaignsSent": 123,
"tags": [
{
"label": "<string>",
"uniqueId": "<string>"
}
],
"uniqueId": "<string>",
"createdAt": "2023-11-07T05:31:56Z"
}
],
"isLinkTrackingEnabled": true,
"tags": [
{
"label": "<string>",
"uniqueId": "<string>"
}
],
"description": "<string>",
"organizationId": "<string>",
"sentAt": "2023-11-07T05:31:56Z",
"scheduledAt": "2023-11-07T05:31:56Z",
"templateMessageId": "<string>",
"phoneNumberInUse": "<string>",
"templateComponentParameters": {
"header": [
{
"nameOrIndex": "<string>",
"label": "<string>",
"parameterType": "static",
"dynamicField": "<string>",
"staticValue": "<string>",
"example": "<string>",
"placeholder": "<string>"
}
],
"body": [
{
"nameOrIndex": "<string>",
"label": "<string>",
"parameterType": "static",
"dynamicField": "<string>",
"staticValue": "<string>",
"example": "<string>",
"placeholder": "<string>"
}
],
"buttons": [
{
"nameOrIndex": "<string>",
"label": "<string>",
"parameterType": "static",
"dynamicField": "<string>",
"staticValue": "<string>",
"example": "<string>",
"placeholder": "<string>"
}
],
"productSections": [
{
"title": "<string>",
"productItems": [
{
"productRetailerId": "<string>"
}
]
}
],
"catalogId": "<string>",
"productRetailerId": "<string>"
},
"stats": {
"totalRecipients": 123,
"messagesSent": 123,
"messagesFailed": 123,
"messagesDelivered": 123,
"messagesUndelivered": 123,
"messagesRead": 123,
"totalMessages": 123,
"conversationInitiated": 123,
"responseRate": 123,
"openRate": 123,
"engagementRate": 123,
"totalLinkClicks": 123,
"engagementTrends": [
{
"date": "2023-11-07T05:31:56Z",
"label": "<string>",
"count": 123
}
],
"linkClicksData": [
{
"date": "2023-11-07T05:31:56Z",
"label": "<string>",
"count": 123
}
],
"messageAnalytics": [
{
"date": "2023-11-07T05:31:56Z",
"label": "<string>",
"sent": 123,
"delivered": 123,
"replied": 123,
"read": 123
}
]
},
"progress": {
"totalMessages": 123,
"sent": 123
}
}
],
"paginationMeta": {
"page": 123,
"per_page": 123,
"total": 123
}
}number of records to skip
max number of records to return per page
order by asc or desc
asc, desc sort by a field
Draft, Scheduled, Running, Paused, Cancelled, Finished list of campaigns
Show child attributes
Draft, Scheduled, Running, Paused, Cancelled, Finished Show child attributes
Object representing template component parameters. It consists of separate arrays for header, body, and button parameters.
Show child attributes
Parameters for header components.
Show child attributes
The name or index identifying the parameter.
The display label for the parameter.
Specifies whether the parameter is static or dynamic.
static, dynamic For dynamic parameters, the field name to resolve (e.g. 'firstName').
The static value to be used if applicable.
An example value for the parameter.
Placeholder text to guide the user input.
Parameters for body components.
Show child attributes
The name or index identifying the parameter.
The display label for the parameter.
Specifies whether the parameter is static or dynamic.
static, dynamic For dynamic parameters, the field name to resolve (e.g. 'firstName').
The static value to be used if applicable.
An example value for the parameter.
Placeholder text to guide the user input.
Parameters for button components.
Show child attributes
The name or index identifying the parameter.
The display label for the parameter.
Specifies whether the parameter is static or dynamic.
static, dynamic For dynamic parameters, the field name to resolve (e.g. 'firstName').
The static value to be used if applicable.
An example value for the parameter.
Placeholder text to guide the user input.
Show child attributes
Show child attributes
Was this page helpful?