GET
/
campaigns
/
{id}
curl --request GET \
  --url https://api.wapikit.com/api/campaigns/{id}
{
  "campaign": {
    "uniqueId": "<string>",
    "name": "<string>",
    "description": "<string>",
    "organizationId": "<string>",
    "status": "Draft",
    "sentAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "scheduledAt": "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"
      }
    ],
    "templateMessageId": "<string>",
    "isLinkTrackingEnabled": true,
    "phoneNumberInUse": "<string>",
    "tags": [
      {
        "label": "<string>",
        "uniqueId": "<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>"
        }
      ],
      "catalogId": "<string>",
      "productRetailerId": "<string>",
      "productSections": [
        {
          "title": "<string>",
          "productItems": [
            {
              "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
    }
  }
}

Path Parameters

id
string
required

The id value of the campaign you want to get.

Response

200
application/json

gets a single campaign.

The response is of type object.