Skip to main content
GET
/
v1
/
campaign
/
{campaignId}
/
analytics
Get campaign analytics
curl --request GET \
  --url https://openapi.enginy.ai/v1/campaign/{campaignId}/analytics \
  --header 'x-api-key: <api-key>'
{
  "status": "success",
  "message": "<string>",
  "data": {
    "campaignId": 123,
    "campaignName": "<string>",
    "status": "DRAFT",
    "isActive": true,
    "isPaused": true,
    "isArchived": true,
    "overview": {
      "totalContacts": 123,
      "started": 123,
      "contacted": 123,
      "replied": 123,
      "positive": 123
    },
    "progressByChannelList": {
      "all": {
        "totalLeads": 123,
        "started": 123,
        "contacted": 123,
        "replied": 123,
        "tagged": 123,
        "positive": 123
      },
      "linkedin": {
        "totalLeads": 123,
        "engaged": 123,
        "invited": 123,
        "sentConnections": 123,
        "alreadySentConnections": 123,
        "accepted": 123,
        "acceptedConnections": 123,
        "contacted": 123,
        "viewed": 123,
        "followed": 123,
        "replied": 123,
        "tagged": 123,
        "positive": 123
      },
      "email": {
        "totalLeads": 123,
        "sent": 123,
        "viewed": 123,
        "clicked": 123,
        "replied": 123,
        "bounced": 123,
        "tagged": 123,
        "positive": 123
      },
      "whatsapp": {
        "totalLeads": 123,
        "sent": 123,
        "replied": 123,
        "tagged": 123
      },
      "tasks": {
        "pending": 123,
        "completed": 123
      }
    },
    "totalContacts": 123,
    "contactRate": 123,
    "replyRate": 123,
    "daily": [
      {
        "date": "2023-11-07T05:31:56Z",
        "contactsAdded": 123,
        "connectionRequestsSent": 123,
        "newMessagesSent": 123,
        "queuedMessagesDueToLimit": 123
      }
    ]
  }
}

Authorizations

x-api-key
string
header
required

Path Parameters

campaignId
string
required

The campaign ID to retrieve analytics for.

Query Parameters

startDate
string

Optional start date in ISO 8601 format. Defaults to the last 30 days.

endDate
string

Optional end date in ISO 8601 format. Defaults to now.

Response

Campaign analytics retrieved successfully

status
enum<string>
required
Available options:
success
message
string
required
data
object
required