| Enum Value | Description |
|---|---|
| 0 | Draft |
| 1 | Active |
| 2 | Paused |
| 3 | Completed |
| 4 | Running Subsequences |
| -99 | Account Suspended |
| -1 | Accounts Unhealthy |
| -2 | Bounce Protect |
The entire API V2 documentation is interactive and can be tested here. To the right side of every endpoint you will see a box with an example request. You can click on the "Try it" button to send a request to the server right from the docs. You will need to provide an API key by clicking the ApiKeyAuth_token blue text.
https://api.instantly.ai/
https://developer.instantly.ai/_mock/api/v2/
https://api.instantly.ai/api/v2/campaigns/search-by-contact
https://developer.instantly.ai/_mock/api/v2/api/v2/campaigns/search-by-contact
curl -i -X GET \
'https://api.instantly.ai/api/v2/campaigns/search-by-contact?search=lead-email%40example.com&sort_column=timestamp_created&sort_order=asc' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'{ "items": [ { … } ] }
https://api.instantly.ai/api/v2/campaigns/analytics
https://developer.instantly.ai/_mock/api/v2/api/v2/campaigns/analytics
curl -i -X GET \
'https://api.instantly.ai/api/v2/campaigns/analytics?end_date=2024-01-01&exclude_total_leads_count=true&id=019a17f3-6af4-7015-8672-50354b7356c7&ids=019a17f3-6af4-7015-8672-5036b759c01c&start_date=2024-01-01' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'[ { "campaign_name": "My Test Campaign", "campaign_id": "019a17f3-6af5-795b-aacb-069a2e0d5e1d", "campaign_status": 1, "campaign_is_evergreen": true, "leads_count": 1500, "contacted_count": 1200, "open_count": 800, "reply_count": 300, "link_click_count": 800, "bounced_count": 50, "unsubscribed_count": 20, "completed_count": 1100, "emails_sent_count": 5000, "new_leads_contacted_count": 200, "total_opportunities": 10, "total_opportunity_value": 1000 } ]
Get analytics overview for one or multiple campaigns. Specify the id field to get the analytics overview for a single campaign, or leave it empty to get the analytics overview for all campaigns.
Note regarding the interest status totals (interested, meeting booked, meeting completed, closed): these are calculated based on the first occurrence of each event per contact by default. To change this behavior and calculate the totals based on all occurrences of the events, set the expand_crm_events parameter to true. Additionally, there is a 10 minute time window after you change a lead status in which the subsequent updates will NOT insert new analytics events to avoid duplicates from rapid status changes and avoid false inflation of the analytics numbers.
A campaign ID to get the analytics overview for. Leave this field empty to get the analytics overview for all campaigns
Filter by campaign status (only the analytics for the campaigns with the specified status will be returned)
| Enum Value | Description |
|---|---|
| 0 | Draft |
| 1 | Active |
| 2 | Paused |
| 3 | Completed |
| 4 | Running Subsequences |
| -99 | Account Suspended |
| -1 | Accounts Unhealthy |
| -2 | Bounce Protect |
When true, calculates the total of all the lead interest status update events instead of only the first occurrence for each contact. This will affect the following fields: total_opportunities, total_interested, total_meeting_booked, total_meeting_completed, and total_closed. Example: if a lead goes from interested to meeting booked to closed, it will count as 3 events (total_interested: 1, total_meeting_booked_1, and total_closed: 1) when this parameter is set to true, and as 1 event (total_interested) when it is set to false (default).
https://api.instantly.ai/api/v2/campaigns/analytics/overview
https://developer.instantly.ai/_mock/api/v2/api/v2/campaigns/analytics/overview
curl -i -X GET \
'https://api.instantly.ai/api/v2/campaigns/analytics/overview?campaign_status=1&end_date=2024-01-01&expand_crm_events=true&id=019a17f3-6af5-795b-aacb-069b8c6c7861&ids=019a17f3-6af5-795b-aacb-069c4862c19a&start_date=2024-01-01' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'Default Response
The total number of times the emails were opened, including duplicates
The unique number of times the emails were opened (counted once per lead, step, and campaign)
The number of links that got clicked (for the first time)
The unique number of links that got clicked, per step (counted once per lead, step, and campaign)
The number of leads that replied to at least one email (for the first time only)
The unique number of leads that replied to at least one email, per step (counted once per lead, step, and campaign)
The total number of meeting completed opportunities created
{ "open_count": 800, "open_count_unique": 800, "open_count_unique_by_step": 800, "link_click_count": 800, "link_click_count_unique": 800, "link_click_count_unique_by_step": 800, "reply_count": 300, "reply_count_unique": 300, "reply_count_unique_by_step": 300, "bounced_count": 50, "unsubscribed_count": 20, "completed_count": 1100, "emails_sent_count": 5000, "new_leads_contacted_count": 200, "total_opportunities": 10, "total_opportunity_value": 1000, "total_interested": 103, "total_meeting_booked": 45, "total_meeting_completed": 12, "total_closed": 10 }