Get campaign report

Reads the numbers of one campaign: opens, clicks, bounces, unsubscribes and spam complaints.

GET https://cotlet.dev/api/v1/agile-crm/campaigns/{campaign_id}/report

read

Returns the counts Agile CRM shows behind the campaign's reporting icon, plus the clicked links with their click counts. Agile tracks opens and clicks only for HTML emails, so a plain-text campaign reports none. The call reads only; nothing is sent to contacts.

Parameters

Parameters: get_campaign_report
NameTypeDescription
campaign_id string required string Campaign id from list_campaigns

Request

cURL
curl https://cotlet.dev/api/v1/agile-crm/campaigns/5731834621411328/report \
  -H "Authorization: Bearer $COTLET_API_KEY"
Python
result = client.call("agile-crm", "get_campaign_report", {"campaign_id":"5731834621411328"})
Node.js
const result = await cotlet.call('agile-crm', 'get_campaign_report', {"campaign_id":"5731834621411328"});
CLI
cotlet call agile-crm get_campaign_report --data '{"campaign_id":"5731834621411328"}'

Example response

JSON

{
  "campaign_id": "5731834621411328",
  "name": "Onboarding series",
  "opened": 412,
  "clicked": 96,
  "bounced": 18,
  "unsubscribed": 7,
  "spam_complaints": 1,
  "links": [
    {
      "url": "https://example.com/start",
      "clicks": 61
    },
    {
      "url": "https://example.com/pricing",
      "clicks": 35
    }
  ]
}

Sign in once. Your agent does the rest.

Sign up and add the apps you need. Free 7-day trial with 2,000 credits, no card needed.