Analytics
/
Get campaign(s) analytics

API Explorer (2.0.0)

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.

Languages
Servers
Instantly API Server
https://api.instantly.ai/
Mock server
https://developer.instantly.ai/_mock/api/v2/

Analytics

Endpoints related to analytics

Operations

Get warmup analytics

Request

Requires one of the following scopes: accounts:read, accounts:all, all:read, all:all

Bodyapplication/jsonrequired
emailsArray of strings[ 1 .. 100 ] itemsrequired

List of emails to get warmup analytics for. The emails should be attached to accounts in your workspace.

Example: ["user@example.com"]
curl -i -X POST \
  https://api.instantly.ai/api/v2/accounts/warmup-analytics \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "emails": [
      "user@example.com"
    ]
  }'

Responses

Default Response

Bodyapplication/json
email_date_dataobject
Example: {"example1@example.com":{"2023-10-01":{"sent":10,"landed_inbox":8,"landed_spam":2,"received":10},"2023-10-02":{"sent":5,"landed_inbox":5,"received":5}},"example2@example.com":{"2023-10-01":{"sent":7,"landed_inbox":7,"received":7}}}
aggregate_dataobject
Example: {"example1@example.com":{"sent":15,"landed_inbox":13,"landed_spam":2,"received":15,"health_score_label":"87%","health_score":87},"example2@example.com":{"sent":7,"landed_inbox":7,"health_score_label":"100%","health_score":100}}
Response
application/json
{
  "email_date_data": {
    "example1@example.com": { … },
    "example2@example.com": { … }
  },
  "aggregate_data": {
    "example1@example.com": { … },
    "example2@example.com": { … }
  }
}

Test account vitals

Request

Requires one of the following scopes: accounts:read, accounts:all, all:read, all:all

Bodyapplication/json
accountsArray of strings
Example: ["user@example.com"]
curl -i -X POST \
  https://api.instantly.ai/api/v2/accounts/test/vitals \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Responses

Default Response

Bodyapplication/json
statusstring
Example: "success"
success_listArray of objects
failure_listArray of objects
Response
application/json
{
  "status": "success",
  "success_list": [
    { … }
  ],
  "failure_list": [
    { … }
  ]
}

Get campaign(s) analytics

Request

Get analytics for one or multiple campaigns. Specify the id field to get the analytics for a single campaign, or leave it empty to get the analytics for all campaigns

Query
idstring(uuid)

Campaign ID

Example: id=01959271-2faa-733d-9614-15fe7004b989
start_datestring

Start date

Example: start_date=2024-01-01
end_datestring

End date

Example: end_date=2024-01-01
curl -i -X GET \
  'https://api.instantly.ai/api/v2/campaigns/analytics?end_date=2024-01-01&id=01959271-2faa-733d-9614-15fe7004b989&start_date=2024-01-01' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Default Response

Bodyapplication/jsonArray [
campaign_namestring

The name of the campaign

Example: "Summer Sale Campaign"
campaign_idstring(uuid)

The ID of the campaign

Example: "01959271-2faa-733d-9614-15ff195a37e0"
leads_countinteger

The total number of leads

Example: 1500
contacted_countinteger

Number of leads for whom the sequence has started

Example: 1200
open_countinteger

The number of leads that opened at least one email

Example: 800
reply_countinteger

The number of leads that replied to at least one email

Example: 300
bounced_countinteger

The number of bounced leads

Example: 50
unsubscribed_countinteger

The number of unsubscribed leads

Example: 20
completed_countinteger

The number of leads that the campaign was completed for

Example: 1100
emails_sent_countinteger

The total number of sent emails

Example: 5000
new_leads_contacted_countinteger

The total number of new leads contacted

Example: 200
total_opportunitiesinteger

The total number of opportunities created

Example: 10
total_opportunity_valuenumber

The total value of opportunities created

Example: 1000
]
Response
application/json
[
  {
    "campaign_name": "Summer Sale Campaign",
    "campaign_id": "01959271-2faa-733d-9614-15ff195a37e0",
    "leads_count": 1500,
    "contacted_count": 1200,
    "open_count": 800,
    "reply_count": 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
  }
]

Account

An email account that can be used to send campaigns

Operations

Campaign

A campaign that can be sent to a list of recipients

Operations

Email

A campaign email, a reply, a manually sent email, or any other email that's visible in the Unibox

Operations

Email Verification

A single email verification

Operations

Lead List

A list used to store leads

Operations

Inbox Placement Test

An inbox placement test

Operations

Inbox Placement Analytics

Analytics data for individual emails in inbox placement tests

Operations

Inbox Placement Blacklist & SpamAssassin Report

Report data for an inbox placement test

Operations

API Key

API Key

Operations

Account Campaign Mapping

Account Campaign Mapping

Operations

Lead

A lead entity representing an individual lead

Operations

Background Job

A background job that can be used to perform long-running tasks

Operations

Custom Tag

A custom tag for organizing and categorizing items

Operations

Block List Entry

A blocked email or domain

Operations

Lead Label

A custom label for categorizing and managing leads

Operations

Workspace

A workspace entity representing a workspace

Operations

Workspace Group Member

A member of a workspace group. You can use the endpoints within this entity to manage the members of a workspace group.

Operations

Workspace Member

A member of a workspace with associated user details

Operations

Campaign Subsequence

A subsequence entity representing a follow-up sequence

Operations

Schemas