# Table of Contents - [API V1 to API V2 Migration](#api-v1-to-api-v2-migration) - [Account](#account) - [CRM Actions](#crm-actions) - [Analytics](#analytics) - [Initialize google oauth](#initialize-google-oauth) - [Get campaign(s) analytics](#get-campaign-s-analytics) - [Get warmup analytics](#get-warmup-analytics) - [Get daily campaign analytics](#get-daily-campaign-analytics) - [OAuth](#oauth) - [Account](#account) - [Initialize microsoft oauth](#initialize-microsoft-oauth) --- # API V1 to API V2 Migration API V1 to API V2 Migration Last updated 1 hour ago [](https://developer.instantly.ai/api-v1-docs#api-v1-to-api-v2-migration) API V1 to API V2 Migration ==================================================================================================== ⚠️ **Note**: API v1 is going to be deprecated on **Jan 19, 2026**. Please use API v2 instead. The first version of the API is available at [here](https://app.theneo.io/instantly-ai/instantlyapidocs/introduction) . API V2 comes with significantly more endpoints than V1, offering expanded functionality for managing your campaigns, leads, and accounts. This guide covers the migration paths for existing V1 endpoints. [](https://developer.instantly.ai/api-v1-docs#integrations-using-api-v1) Integrations using api V1 -------------------------------------------------------------------------------------------------- **The integrations using api v1, like Zapier, Make, etc., will keep working without any disruptions.** [](https://developer.instantly.ai/api-v1-docs#api-v2-api-key) API V2 API Key ---------------------------------------------------------------------------- Get an API V2 Key: check the [getting started guide](https://developer.instantly.ai/getting-started/getting-started) . [](https://developer.instantly.ai/api-v1-docs#api-v1-to-api-v2-endpoint-mapping) API V1 to API V2 Endpoint Mapping ------------------------------------------------------------------------------------------------------------------ ### [](https://developer.instantly.ai/api-v1-docs#campaign-endpoints) Campaign Endpoints | API V1 Endpoint | API V2 Endpoint | Method | Notes | | --- | --- | --- | --- | | `GET /campaign/list` | `GET /api/v2/campaigns` | GET | Now supports pagination with `starting_after` | | `GET /campaign/get/name` | `GET /api/v2/campaigns/{id}` | GET | Campaign name is in the response object | | `GET /campaign/get/status` | `GET /api/v2/campaigns/{id}` | GET | Status is in the response object | | `POST /campaign/set/name` | `PATCH /api/v2/campaigns/{id}` | PATCH | Use PATCH with `{"name": "New Name"}` | | `GET /campaign/get/accounts` | `GET /api/v2/campaigns/{id}` | GET | Accounts are in the response object in the `email_list` array | | `POST /campaign/set/accounts` | `PATCH /api/v2/campaigns/{id}` | PATCH | Update with `email_list` array | | `POST /campaign/add-account` | `PATCH /api/v2/campaigns/{id}` | PATCH | Add to accounts array | | `POST /campaign/remove-account` | `PATCH /api/v2/campaigns/{id}` | PATCH | Remove from accounts array | | `POST /campaign/set/schedule` | `PATCH /api/v2/campaigns/{id}` | PATCH | Update `campaign_schedule` object | | `POST /campaign/launch` | `POST /api/v2/campaigns/{id}/activate` | POST | Dedicated activate endpoint | | `POST /campaign/pause` | `POST /api/v2/campaigns/{id}/pause` | POST | Dedicated pause endpoint | ### [](https://developer.instantly.ai/api-v1-docs#analytics-endpoints) Analytics Endpoints | API V1 Endpoint | API V2 Endpoint | Method | Notes | | --- | --- | --- | --- | | `GET /analytics/campaign/summary` | `GET /api/v2/campaigns/analytics` | GET | Pass campaign ID as query param `id` | | `GET /analytics/campaign/count` | `GET /api/v2/campaigns/analytics/overview` | GET | Overview endpoint | ### [](https://developer.instantly.ai/api-v1-docs#lead-endpoints) Lead Endpoints | API V1 Endpoint | API V2 Endpoint | Method | Notes | | --- | --- | --- | --- | | `POST /lead/add` | `POST /api/v2/leads` | POST | Can add to campaign or lead list | | `GET /lead/get` | `POST /api/v2/leads/list` | POST | Now POST for complex filtering | | `POST /lead/delete` | `DELETE /api/v2/leads/{id}` | DELETE | Delete by lead ID | | `POST /lead/update-status` | `PATCH /api/v2/leads/{id}` | PATCH | Update `interest_status` field | | `POST /lead/variable/update` | `PATCH /api/v2/leads/{id}` | PATCH | Update `payload` object | | `POST /lead/variable/set` | `PATCH /api/v2/leads/{id}` | PATCH | Set fields in `payload` object | | `POST /lead/variable/delete` | `PATCH /api/v2/leads/{id}` | PATCH | Update `payload` without deleted fields | ### [](https://developer.instantly.ai/api-v1-docs#account-endpoints) Account Endpoints | API V1 Endpoint | API V2 Endpoint | Method | Notes | | --- | --- | --- | --- | | `GET /account/list` | `GET /api/v2/accounts` | GET | Supports filtering and limiting | | `POST /account/check-vitals` | `POST /api/v2/accounts/test/vitals` | POST | Same behavior | | `GET /account/get/status` | `GET /api/v2/accounts/{email}` | GET | Get by email address | | `POST /account/warmup/enable` | `POST /api/v2/accounts/warmup/enable` | POST | Returns background job | | `POST /account/warmup/pause` | `POST /api/v2/accounts/warmup/disable` | POST | Note: endpoint is `/disable` not `/pause` | | `POST /account/delete` | `DELETE /api/v2/accounts/{email}` | DELETE | Delete by email | ### [](https://developer.instantly.ai/api-v1-docs#blocklist-endpoints) Blocklist Endpoints | API V1 Endpoint | API V2 Endpoint | Method | Notes | | --- | --- | --- | --- | | `POST /blocklist/add` | `POST /api/v2/block-lists-entries` | POST | Add entries | | `POST /blocklist/remove` | `DELETE /api/v2/block-lists-entries/{id}` | DELETE | Delete by entry ID | ### [](https://developer.instantly.ai/api-v1-docs#unibox-email-endpoints) Unibox (Email) Endpoints | API V1 Endpoint | API V2 Endpoint | Method | Notes | | --- | --- | --- | --- | | `GET /unibox/emails/list` | `GET /api/v2/emails` | GET | List with filtering | | `GET /unibox/emails/unread/count` | `GET /api/v2/emails/unread/count` | GET | Dedicated count endpoint | | `POST /unibox/threads/mark-read` | `POST /api/v2/emails/threads/{thread_id}/mark-as-read` | PATCH | Mark emails as read by updating the status | | `POST /unibox/reply` | `POST /api/v2/emails/reply` | POST | eply with `reply_to_uuid` in bodyad | ### [](https://developer.instantly.ai/api-v1-docs#tags-endpoints) Tags Endpoints | API V1 Endpoint | API V2 Endpoint | Method | Notes | | --- | --- | --- | --- | | `POST /tag/create` | `POST /api/v2/custom-tags` | POST | Create tag | | `GET /tag/get` | `GET /api/v2/custom-tags/{id}` | GET | Get by ID | | `GET /tag/list` | `GET /api/v2/custom-tags` | GET | List all | | `PATCH /tag/update` | `PATCH /api/v2/custom-tags/{id}` | PATCH | Update by ID | | `DELETE /tag/delete` | `DELETE /api/v2/custom-tags/{id}` | DELETE | Delete by ID | | `POST /tag/assign` | `POST /api/v2/custom-tags/toggle-resource` | POST | Assign/unassign tags | ### [](https://developer.instantly.ai/api-v1-docs#email-verification-endpoints) Email Verification Endpoints | API V1 Endpoint | API V2 Endpoint | Method | Notes | | --- | --- | --- | --- | | `POST /verify/email` | `POST /api/v2/email-verification` | POST | Verify single email | | `GET /verify/email/result` | `GET /api/v2/email-verification/{email}` | GET | Get result by email address | ### [](https://developer.instantly.ai/api-v1-docs#custom-tracking-domain-endpoints) Custom Tracking Domain Endpoints | API V1 Endpoint | API V2 Endpoint | Method | Notes | | --- | --- | --- | --- | | `GET /tracking-domain/status` | `GET /api/v2/accounts/ctd-status` | GET | Get custom tracking domain status | #### Was this helpful? Previous page[OAuth Account API Integration Guide](https://developer.instantly.ai/oauth-connection-flow) Next page[API Explorer](https://developer.instantly.ai/api/v2) --- # Account [Account](https://developer.instantly.ai/api/v2/account) 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/ [](https://developer.instantly.ai/api/v2/analytics) Analytics ------------------------------------------------------------- Endpoints related to analytics Operations post /api/v2/accounts/warmup-analytics get /api/v2/accounts/analytics/daily post /api/v2/accounts/test/vitals get /api/v2/campaigns/analytics get /api/v2/campaigns/analytics/overview get /api/v2/campaigns/analytics/daily get /api/v2/campaigns/analytics/steps \+ Show [](https://developer.instantly.ai/api/v2/oauth) OAuth ----------------------------------------------------- OAuth authentication endpoints for connecting Google and Microsoft email accounts Operations post /api/v2/oauth/google/init post /api/v2/oauth/microsoft/init get /api/v2/oauth/session/status/{sessionId} \+ Show [](https://developer.instantly.ai/api/v2/account) Account --------------------------------------------------------- An email account that can be used to send campaigns Operations post /api/v2/accounts get /api/v2/accounts get /api/v2/accounts/{email} patch /api/v2/accounts/{email} delete /api/v2/accounts/{email} post /api/v2/accounts/warmup/enable post /api/v2/accounts/warmup/disable post /api/v2/accounts/warmup-analyticsShow 7 more... [](https://developer.instantly.ai/api/v2/account/def-0) Account --------------------------------------------------------------- An email account that can be used to send campaigns [](https://developer.instantly.ai/api/v2/account#path=email) email_string__(email)_required Email address of the account Example: "user@example.com" [](https://developer.instantly.ai/api/v2/account#path=timestamp_created) timestamp\_created_string__(date-time)_read-onlyrequired Timestamp when the account was created Example: "2026-02-26T19:34:09.231Z" [](https://developer.instantly.ai/api/v2/account#path=timestamp_updated) timestamp\_updated_string__(date-time)_read-onlyrequired Timestamp when the account was last updated Example: "2026-02-26T19:34:09.231Z" [](https://developer.instantly.ai/api/v2/account#path=first_name) first\_name_string_required First name associated with the account Example: "John" [](https://developer.instantly.ai/api/v2/account#path=last_name) last\_name_string_required Last name associated with the account Example: "Doe" [](https://developer.instantly.ai/api/v2/account#path=organization) organization_string__(uuid)_read-onlyrequired Organization ID that owns this account Example: "019c9b71-c04f-7265-828a-12ab251a7600" [](https://developer.instantly.ai/api/v2/account#path=warmup_status) warmup\_status_number_read-onlyrequired Current warmup status of the account | Enum Value | Description | | --- | --- | | 0 | Paused | | 1 | Active | | \-1 | Banned | | \-2 | Spam Folder Unknown | | \-3 | Permanent Suspension | Example: 1 [](https://developer.instantly.ai/api/v2/account#path=provider_code) provider\_code_number_required Provider code for the account. Please make sure to specify the right provider code, otherwise your account will not work. | Enum Value | Description | | --- | --- | | 1 | Custom IMAP/SMTP | | 2 | Google | | 3 | Microsoft | | 4 | AWS | | 8 | AirMail | Example: 2 [](https://developer.instantly.ai/api/v2/account#path=setup_pending) setup\_pending_boolean_read-onlyrequired Whether account setup is pending Example: false [](https://developer.instantly.ai/api/v2/account#path=is_managed_account) is\_managed\_account_boolean_read-onlyrequired Whether this is a managed account Example: false [](https://developer.instantly.ai/api/v2/account#path=warmup) warmup_object_ Warmup configuration for the account +Show 5 properties [](https://developer.instantly.ai/api/v2/account#path=added_by) added\_by_null or string__(uuid)_read-only User ID who added the account Example: "019c9b71-c04f-7265-828a-12a956e6c4b2" [](https://developer.instantly.ai/api/v2/account#path=daily_limit) daily\_limit_null or number_ Daily email sending limit Example: 100 [](https://developer.instantly.ai/api/v2/account#path=modified_by) modified\_by_null or string__(uuid)_read-only User ID who last modified the account Example: "019c9b71-c04f-7265-828a-12aa51bed589" [](https://developer.instantly.ai/api/v2/account#path=tracking_domain_name) tracking\_domain\_name_null or string_ Tracking domain Example: "example.com" [](https://developer.instantly.ai/api/v2/account#path=tracking_domain_status) tracking\_domain\_status_null or string_ Tracking domain status Example: "active" [](https://developer.instantly.ai/api/v2/account#path=status) status_number_read-only Current status of the account | Enum Value | Description | | --- | --- | | 1 | Active | | 2 | Paused | | 3 | Temporarily paused for maintenance; will be automatically resumed shortly | | \-1 | Connection Error | | \-2 | Soft Bounce Error | | \-3 | Sending Error | Example: 1 [](https://developer.instantly.ai/api/v2/account#path=enable_slow_ramp) enable\_slow\_ramp_null or boolean_ Whether to enable slow ramp up for sending limits Example: false [](https://developer.instantly.ai/api/v2/account#path=inbox_placement_test_limit) inbox\_placement\_test\_limit_null or number_ The limit for inbox placement tests Example: 10 [](https://developer.instantly.ai/api/v2/account#path=timestamp_last_used) timestamp\_last\_used_null or string__(date-time)_read-only Timestamp when the account was last used Example: "2026-02-26T19:34:09.231Z" [](https://developer.instantly.ai/api/v2/account#path=status_message) status\_message_object_read-only Status message for the account +Show 6 properties [](https://developer.instantly.ai/api/v2/account#path=timestamp_warmup_start) timestamp\_warmup\_start_null or string__(date-time)_read-only Timestamp when warmup was started Example: "2026-02-26T19:34:09.231Z" [](https://developer.instantly.ai/api/v2/account#path=warmup_pool_id) warmup\_pool\_id_null or string__(uuid)_read-only ID of the warmup pool this account belongs to Example: "019c9b71-c04f-7265-828a-12acb0282095" [](https://developer.instantly.ai/api/v2/account#path=dfy_password_changed) dfy\_password\_changed_null or boolean_read-only Whether DFY password has been changed Example: false [](https://developer.instantly.ai/api/v2/account#path=stat_warmup_score) stat\_warmup\_score_null or number_read-only Warmup score for the account Example: 85 [](https://developer.instantly.ai/api/v2/account#path=sending_gap) sending\_gap_number__\[ 0 .. 1440 \]_ The gap between emails sent from this account in minutes (minimum wait time when used with multiple campaigns) Example: 10 [](https://developer.instantly.ai/api/v2/account#path=signature) signature_null or string_ Email signature for the account Example: "Best regards, John Doe" { "email": "user@example.com", "timestamp\_created": "2026-02-26T19:34:09.231Z", "timestamp\_updated": "2026-02-26T19:34:09.231Z", "first\_name": "John", "last\_name": "Doe", "warmup": { "limit": 100, "advanced": { … }, "warmup\_custom\_ftag": "warmup", "increment": "disabled", "reply\_rate": 0.1 }, "added\_by": "019c9b71-c04f-7265-828a-12a956e6c4b2", "daily\_limit": 100, "modified\_by": "019c9b71-c04f-7265-828a-12aa51bed589", "tracking\_domain\_name": "example.com", "tracking\_domain\_status": "active", "status": 1, "enable\_slow\_ramp": false, "inbox\_placement\_test\_limit": 10, "organization": "019c9b71-c04f-7265-828a-12ab251a7600", "timestamp\_last\_used": "2026-02-26T19:34:09.231Z", "warmup\_status": 1, "status\_message": { "code": "EENVELOPE", "command": "DATA", "response": "550-5.4.5 Daily user sending limit exceeded. For more information on Gmai", "e\_message": "error: data command failed: 550-5.4.5 daily user sending limit exceeded", "responseCode": 550 }, "timestamp\_warmup\_start": "2026-02-26T19:34:09.231Z", "provider\_code": 2, "setup\_pending": false, "warmup\_pool\_id": "019c9b71-c04f-7265-828a-12acb0282095", "is\_managed\_account": false, "dfy\_password\_changed": false, "stat\_warmup\_score": 85, "sending\_gap": 10, "signature": "Best regards, John Doe" } [](https://developer.instantly.ai/api/v2/account/createaccount) Create account ------------------------------------------------------------------------------ #### [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/request) RequestExpand all Requires one of the following scopes: `accounts:create`, `accounts:all`, `all:create`, `all:all` Security: ApiKeyAuth [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/request/body) Bodyapplication/jsonrequired The Account to create [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=request&path=email) email_string__(email)_required Email address of the account Example: "user@example.com" [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=request&path=first_name) first\_name_string_required First name associated with the account Example: "John" [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=request&path=last_name) last\_name_string_required Last name associated with the account Example: "Doe" [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=request&path=provider_code) provider\_code_number_required Provider code for the account. Please make sure to specify the right provider code, otherwise your account will not work. | Enum Value | Description | | --- | --- | | 1 | Custom IMAP/SMTP | | 2 | Google | | 3 | Microsoft | | 4 | AWS | | 8 | AirMail | Example: 2 [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=request&path=imap_username) imap\_username_string_required Example: "username" [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=request&path=imap_password) imap\_password_string_required Example: "password" [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=request&path=imap_host) imap\_host_string_required Example: "imap.gmail.com" [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=request&path=imap_port) imap\_port_number_required Example: 993 [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=request&path=smtp_username) smtp\_username_string_required Example: "username" [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=request&path=smtp_password) smtp\_password_string_required Example: "password" [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=request&path=smtp_host) smtp\_host_string_required Example: "smtp.gmail.com" [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=request&path=smtp_port) smtp\_port_number_required Example: 587 [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=request&path=warmup) warmup_object_ Warmup configuration for the account +Show 5 properties [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=request&path=daily_limit) daily\_limit_number or null_ Daily email sending limit Example: 100 [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=request&path=tracking_domain_name) tracking\_domain\_name_string or null_ Tracking domain Example: "example.com" [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=request&path=tracking_domain_status) tracking\_domain\_status_string or null_ Tracking domain status Example: "active" [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=request&path=enable_slow_ramp) enable\_slow\_ramp_boolean or null_ Whether to enable slow ramp up for sending limits Example: false [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=request&path=inbox_placement_test_limit) inbox\_placement\_test\_limit_number or null_ The limit for inbox placement tests Example: 10 [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=request&path=sending_gap) sending\_gap_number__\[ 0 .. 1440 \]_ The gap between emails sent from this account in minutes (minimum wait time when used with multiple campaigns) Example: 10 [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=request&path=signature) signature_string or null_ Email signature for the account Example: "Best regards, John Doe" [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=request&path=reply_to) reply\_to_string_ Example: "reply@example.com" [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=request&path=warmup_custom_ftag) warmup\_custom\_ftag_string_ Example: "warmup" [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=request&path=skip_cname_check) skip\_cname\_check_boolean_ Example: false post /api/v2/accounts * Instantly API Server https://api.instantly.ai/api/v2/accounts * Mock server https://developer.instantly.ai/\_mock/api/v2/api/v2/accounts curl * curl * JavaScript * Node.js * Python * Java * C# * PHP * Go * Ruby * R * Payload curl -i -X POST \\ https://api.instantly.ai/api/v2/accounts \\ -H 'Authorization: Bearer ' \\ -H 'Content-Type: application/json' \\ -d '{ "email": "user@example.com", "first\_name": "John", "last\_name": "Doe", "provider\_code": 2, "imap\_username": "username", "imap\_password": "password", "imap\_host": "imap.gmail.com", "imap\_port": 993, "smtp\_username": "username", "smtp\_password": "password", "smtp\_host": "smtp.gmail.com", "smtp\_port": 587 }' Try it #### [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/response&c=200) Responses 1. 200 2. 400 3. 401 4. 429 Expand all The Account [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/response&c=200/body) Bodyapplication/json [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=response&c=200&path=email) email_string__(email)_required Email address of the account Example: "user@example.com" [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=response&c=200&path=timestamp_created) timestamp\_created_string__(date-time)_read-onlyrequired Timestamp when the account was created Example: "2026-02-26T19:34:09.231Z" [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=response&c=200&path=timestamp_updated) timestamp\_updated_string__(date-time)_read-onlyrequired Timestamp when the account was last updated Example: "2026-02-26T19:34:09.231Z" [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=response&c=200&path=first_name) first\_name_string_required First name associated with the account Example: "John" [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=response&c=200&path=last_name) last\_name_string_required Last name associated with the account Example: "Doe" [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=response&c=200&path=organization) organization_string__(uuid)_read-onlyrequired Organization ID that owns this account Example: "019c9b71-c04f-7265-828a-12ab251a7600" [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=response&c=200&path=warmup_status) warmup\_status_number_read-onlyrequired Current warmup status of the account | Enum Value | Description | | --- | --- | | 0 | Paused | | 1 | Active | | \-1 | Banned | | \-2 | Spam Folder Unknown | | \-3 | Permanent Suspension | Example: 1 [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=response&c=200&path=provider_code) provider\_code_number_required Provider code for the account. Please make sure to specify the right provider code, otherwise your account will not work. | Enum Value | Description | | --- | --- | | 1 | Custom IMAP/SMTP | | 2 | Google | | 3 | Microsoft | | 4 | AWS | | 8 | AirMail | Example: 2 [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=response&c=200&path=setup_pending) setup\_pending_boolean_read-onlyrequired Whether account setup is pending Example: false [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=response&c=200&path=is_managed_account) is\_managed\_account_boolean_read-onlyrequired Whether this is a managed account Example: false [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=response&c=200&path=warmup) warmup_object_ Warmup configuration for the account +Show 5 properties [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=response&c=200&path=added_by) added\_by_null or string__(uuid)_read-only User ID who added the account Example: "019c9b71-c04f-7265-828a-12a956e6c4b2" [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=response&c=200&path=daily_limit) daily\_limit_null or number_ Daily email sending limit Example: 100 [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=response&c=200&path=modified_by) modified\_by_null or string__(uuid)_read-only User ID who last modified the account Example: "019c9b71-c04f-7265-828a-12aa51bed589" [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=response&c=200&path=tracking_domain_name) tracking\_domain\_name_null or string_ Tracking domain Example: "example.com" [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=response&c=200&path=tracking_domain_status) tracking\_domain\_status_null or string_ Tracking domain status Example: "active" [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=response&c=200&path=status) status_number_read-only Current status of the account | Enum Value | Description | | --- | --- | | 1 | Active | | 2 | Paused | | 3 | Temporarily paused for maintenance; will be automatically resumed shortly | | \-1 | Connection Error | | \-2 | Soft Bounce Error | | \-3 | Sending Error | Example: 1 [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=response&c=200&path=enable_slow_ramp) enable\_slow\_ramp_null or boolean_ Whether to enable slow ramp up for sending limits Example: false [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=response&c=200&path=inbox_placement_test_limit) inbox\_placement\_test\_limit_null or number_ The limit for inbox placement tests Example: 10 [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=response&c=200&path=timestamp_last_used) timestamp\_last\_used_null or string__(date-time)_read-only Timestamp when the account was last used Example: "2026-02-26T19:34:09.231Z" [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=response&c=200&path=status_message) status\_message_object_read-only Status message for the account +Show 6 properties [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=response&c=200&path=timestamp_warmup_start) timestamp\_warmup\_start_null or string__(date-time)_read-only Timestamp when warmup was started Example: "2026-02-26T19:34:09.231Z" [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=response&c=200&path=warmup_pool_id) warmup\_pool\_id_null or string__(uuid)_read-only ID of the warmup pool this account belongs to Example: "019c9b71-c04f-7265-828a-12acb0282095" [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=response&c=200&path=dfy_password_changed) dfy\_password\_changed_null or boolean_read-only Whether DFY password has been changed Example: false [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=response&c=200&path=stat_warmup_score) stat\_warmup\_score_null or number_read-only Warmup score for the account Example: 85 [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=response&c=200&path=sending_gap) sending\_gap_number__\[ 0 .. 1440 \]_ The gap between emails sent from this account in minutes (minimum wait time when used with multiple campaigns) Example: 10 [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=response&c=200&path=signature) signature_null or string_ Email signature for the account Example: "Best regards, John Doe" Response 1. 200 2. 400 3. 401 4. 429 application/json { "email": "user@example.com", "timestamp\_created": "2026-02-26T19:34:09.231Z", "timestamp\_updated": "2026-02-26T19:34:09.231Z", "first\_name": "John", "last\_name": "Doe", "warmup": { "limit": 100, "advanced": { … }, "warmup\_custom\_ftag": "warmup", "increment": "disabled", "reply\_rate": 0.1 }, "added\_by": "019c9b71-c04f-7265-828a-12a956e6c4b2", "daily\_limit": 100, "modified\_by": "019c9b71-c04f-7265-828a-12aa51bed589", "tracking\_domain\_name": "example.com", "tracking\_domain\_status": "active", "status": 1, "enable\_slow\_ramp": false, "inbox\_placement\_test\_limit": 10, "organization": "019c9b71-c04f-7265-828a-12ab251a7600", "timestamp\_last\_used": "2026-02-26T19:34:09.231Z", "warmup\_status": 1, "status\_message": { "code": "EENVELOPE", "command": "DATA", "response": "550-5.4.5 Daily user sending limit exceeded. For more information on Gmai", "e\_message": "error: data command failed: 550-5.4.5 daily user sending limit exceeded", "responseCode": 550 }, "timestamp\_warmup\_start": "2026-02-26T19:34:09.231Z", "provider\_code": 2, "setup\_pending": false, "warmup\_pool\_id": "019c9b71-c04f-7265-828a-12acb0282095", "is\_managed\_account": false, "dfy\_password\_changed": false, "stat\_warmup\_score": 85, "sending\_gap": 10, "signature": "Best regards, John Doe" } #### Was this helpful? [](https://developer.instantly.ai/api/v2/account/listaccount) List account -------------------------------------------------------------------------- #### [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/request) Request Requires one of the following scopes: `accounts:read`, `accounts:all`, `all:read`, `all:all` Security: ApiKeyAuth [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/request/query) Query [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=request&in=query&path=limit) limit_integer__\[ 1 .. 100 \]_ The number of items to return Example: limit=10 [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=request&in=query&path=starting_after) starting\_after_string__(date-time)_ Example: starting\_after=2026-02-26T19:34:20.878Z [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=request&in=query&path=search) search_string_ Example: search=gmail.com [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=request&in=query&path=status) status_number_ | Enum Value | Description | | --- | --- | | 1 | Active | | 2 | Paused | | 3 | Temporarily paused for maintenance; will be automatically resumed shortly | | \-1 | Connection Error | | \-2 | Soft Bounce Error | | \-3 | Sending Error | Example: status=1 [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=request&in=query&path=provider_code) provider\_code_number_ | Enum Value | Description | | --- | --- | | 1 | Custom IMAP/SMTP | | 2 | Google | | 3 | Microsoft | | 4 | AWS | | 8 | AirMail | Example: provider\_code=2 [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=request&in=query&path=tag_ids) tag\_ids_string_ Filter accounts by tag ids. Returns accounts that have any of the specified tags assigned. You can specify multiple tag ids by separating them with a comma. Example: tag\_ids=019c9b71-edce-7f83-a448-f0ebaefe0f82, 019c9b71-edce-7f83-a448-f0ec307668b5 get /api/v2/accounts * Instantly API Server https://api.instantly.ai/api/v2/accounts * Mock server https://developer.instantly.ai/\_mock/api/v2/api/v2/accounts curl * curl * JavaScript * Node.js * Python * Java * C# * PHP * Go * Ruby * R * Payload curl -i -X GET \\ 'https://api.instantly.ai/api/v2/accounts?limit=10&provider\_code=2&search=gmail.com&starting\_after=2026-02-26T19%3A34%3A20.878Z&status=1&tag\_ids=019c9b71-edce-7f83-a448-f0ebaefe0f82%2C%20019c9b71-edce-7f83-a448-f0ec307668b5' \\ -H 'Authorization: Bearer ' Try it #### [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/response&c=200) Responses 1. 200 2. 401 3. 429 Expand all The list of Account [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/response&c=200/body) Bodyapplication/json [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=response&c=200&path=items) items_Array of objects__(Account)_required The list of Account \- [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=response&c=200&path=items/email) items\[\].​email_string__(email)_required Email address of the account Example: "user@example.com" [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=response&c=200&path=items/timestamp_created) items\[\].​timestamp\_created_string__(date-time)_read-onlyrequired Timestamp when the account was created Example: "2026-02-26T19:34:09.231Z" [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=response&c=200&path=items/timestamp_updated) items\[\].​timestamp\_updated_string__(date-time)_read-onlyrequired Timestamp when the account was last updated Example: "2026-02-26T19:34:09.231Z" [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=response&c=200&path=items/first_name) items\[\].​first\_name_string_required First name associated with the account Example: "John" [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=response&c=200&path=items/last_name) items\[\].​last\_name_string_required Last name associated with the account Example: "Doe" [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=response&c=200&path=items/organization) items\[\].​organization_string__(uuid)_read-onlyrequired Organization ID that owns this account Example: "019c9b71-c04f-7265-828a-12ab251a7600" [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=response&c=200&path=items/warmup_status) items\[\].​warmup\_status_number_read-onlyrequired Current warmup status of the account | Enum Value | Description | | --- | --- | | 0 | Paused | | 1 | Active | | \-1 | Banned | | \-2 | Spam Folder Unknown | | \-3 | Permanent Suspension | Example: 1 [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=response&c=200&path=items/provider_code) items\[\].​provider\_code_number_required Provider code for the account. Please make sure to specify the right provider code, otherwise your account will not work. | Enum Value | Description | | --- | --- | | 1 | Custom IMAP/SMTP | | 2 | Google | | 3 | Microsoft | | 4 | AWS | | 8 | AirMail | Example: 2 [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=response&c=200&path=items/setup_pending) items\[\].​setup\_pending_boolean_read-onlyrequired Whether account setup is pending Example: false [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=response&c=200&path=items/is_managed_account) items\[\].​is\_managed\_account_boolean_read-onlyrequired Whether this is a managed account Example: false [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=response&c=200&path=items/warmup) items\[\].​warmup_object_ Warmup configuration for the account +Show 5 properties [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=response&c=200&path=items/added_by) items\[\].​added\_by_null or string__(uuid)_read-only User ID who added the account Example: "019c9b71-c04f-7265-828a-12a956e6c4b2" [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=response&c=200&path=items/daily_limit) items\[\].​daily\_limit_null or number_ Daily email sending limit Example: 100 [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=response&c=200&path=items/modified_by) items\[\].​modified\_by_null or string__(uuid)_read-only User ID who last modified the account Example: "019c9b71-c04f-7265-828a-12aa51bed589" [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=response&c=200&path=items/tracking_domain_name) items\[\].​tracking\_domain\_name_null or string_ Tracking domain Example: "example.com" [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=response&c=200&path=items/tracking_domain_status) items\[\].​tracking\_domain\_status_null or string_ Tracking domain status Example: "active" [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=response&c=200&path=items/status) items\[\].​status_number_read-only Current status of the account | Enum Value | Description | | --- | --- | | 1 | Active | | 2 | Paused | | 3 | Temporarily paused for maintenance; will be automatically resumed shortly | | \-1 | Connection Error | | \-2 | Soft Bounce Error | | \-3 | Sending Error | Example: 1 [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=response&c=200&path=items/enable_slow_ramp) items\[\].​enable\_slow\_ramp_null or boolean_ Whether to enable slow ramp up for sending limits Example: false [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=response&c=200&path=items/inbox_placement_test_limit) items\[\].​inbox\_placement\_test\_limit_null or number_ The limit for inbox placement tests Example: 10 [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=response&c=200&path=items/timestamp_last_used) items\[\].​timestamp\_last\_used_null or string__(date-time)_read-only Timestamp when the account was last used Example: "2026-02-26T19:34:09.231Z" [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=response&c=200&path=items/status_message) items\[\].​status\_message_object_read-only Status message for the account +Show 6 properties [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=response&c=200&path=items/timestamp_warmup_start) items\[\].​timestamp\_warmup\_start_null or string__(date-time)_read-only Timestamp when warmup was started Example: "2026-02-26T19:34:09.231Z" [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=response&c=200&path=items/warmup_pool_id) items\[\].​warmup\_pool\_id_null or string__(uuid)_read-only ID of the warmup pool this account belongs to Example: "019c9b71-c04f-7265-828a-12acb0282095" [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=response&c=200&path=items/dfy_password_changed) items\[\].​dfy\_password\_changed_null or boolean_read-only Whether DFY password has been changed Example: false [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=response&c=200&path=items/stat_warmup_score) items\[\].​stat\_warmup\_score_null or number_read-only Warmup score for the account Example: 85 [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=response&c=200&path=items/sending_gap) items\[\].​sending\_gap_number__\[ 0 .. 1440 \]_ The gap between emails sent from this account in minutes (minimum wait time when used with multiple campaigns) Example: 10 [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=response&c=200&path=items/signature) items\[\].​signature_null or string_ Email signature for the account Example: "Best regards, John Doe" [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=response&c=200&path=next_starting_after) next\_starting\_after_string_ The filter for getting the next items after this one, this could either be a UUID, a timestamp, on an email depending on the specific API Example: "019c9b71-edce-7f83-a448-f0ed04680b33" Response 1. 200 2. 401 3. 429 application/json { "items": \[\ { … }\ \], "next\_starting\_after": "019c9b71-edce-7f83-a448-f0ed04680b33" } #### Was this helpful? [](https://developer.instantly.ai/api/v2/campaign) Campaign ----------------------------------------------------------- A campaign that can be sent to a list of recipients Operations post /api/v2/campaigns get /api/v2/campaigns post /api/v2/campaigns/{id}/activate post /api/v2/campaigns/{id}/pause get /api/v2/campaigns/{id} patch /api/v2/campaigns/{id} delete /api/v2/campaigns/{id} get /api/v2/campaigns/search-by-contactShow 11 more... \+ Show [](https://developer.instantly.ai/api/v2/email) Email ----------------------------------------------------- A campaign email, a reply, a manually sent email, or any other email that's visible in the Unibox Operations post /api/v2/emails/reply post /api/v2/emails/forward get /api/v2/emails get /api/v2/emails/{id} patch /api/v2/emails/{id} delete /api/v2/emails/{id} get /api/v2/emails/unread/count post /api/v2/emails/threads/{thread\_id}/mark-as-read \+ Show [](https://developer.instantly.ai/api/v2/emailverification) Email Verification ------------------------------------------------------------------------------ A single email verification Operations post /api/v2/email-verification get /api/v2/email-verification/{email} \+ Show [](https://developer.instantly.ai/api/v2/leadlist) Lead List ------------------------------------------------------------ A list used to store leads Operations post /api/v2/lead-lists get /api/v2/lead-lists get /api/v2/lead-lists/{id} patch /api/v2/lead-lists/{id} delete /api/v2/lead-lists/{id} get /api/v2/lead-lists/{id}/verification-stats \+ Show [](https://developer.instantly.ai/api/v2/inboxplacementtest) Inbox Placement Test --------------------------------------------------------------------------------- An inbox placement test Operations post /api/v2/inbox-placement-tests get /api/v2/inbox-placement-tests get /api/v2/inbox-placement-tests/{id} delete /api/v2/inbox-placement-tests/{id} patch /api/v2/inbox-placement-tests/{id} get /api/v2/inbox-placement-tests/email-service-provider-options \+ Show [](https://developer.instantly.ai/api/v2/inboxplacementanalytics) Inbox Placement Analytics ------------------------------------------------------------------------------------------- Analytics data for individual emails in inbox placement tests Operations get /api/v2/inbox-placement-analytics get /api/v2/inbox-placement-analytics/{id} post /api/v2/inbox-placement-analytics/stats-by-test-id post /api/v2/inbox-placement-analytics/deliverability-insights post /api/v2/inbox-placement-analytics/stats-by-date \+ Show [](https://developer.instantly.ai/api/v2/inboxplacementblacklistandspamassassinreport) Inbox Placement Blacklist & SpamAssassin Report -------------------------------------------------------------------------------------------------------------------------------------- Report data for an inbox placement test Operations get /api/v2/inbox-placement-reports get /api/v2/inbox-placement-reports/{id} \+ Show [](https://developer.instantly.ai/api/v2/apikey) API Key -------------------------------------------------------- API Key Operations post /api/v2/api-keys get /api/v2/api-keys delete /api/v2/api-keys/{id} \+ Show [](https://developer.instantly.ai/api/v2/accountcampaignmapping) Account Campaign Mapping ----------------------------------------------------------------------------------------- Account Campaign Mapping Operations get /api/v2/account-campaign-mappings/{email} \+ Show [](https://developer.instantly.ai/api/v2/lead) Lead --------------------------------------------------- A lead entity representing an individual lead Operations post /api/v2/leads delete /api/v2/leads post /api/v2/leads/list get /api/v2/leads/{id} patch /api/v2/leads/{id} delete /api/v2/leads/{id} post /api/v2/leads/merge post /api/v2/leads/update-interest-statusShow 5 more... \+ Show [](https://developer.instantly.ai/api/v2/backgroundjob) Background Job ---------------------------------------------------------------------- A background job that can be used to perform long-running tasks Operations get /api/v2/background-jobs get /api/v2/background-jobs/{id} \+ Show [](https://developer.instantly.ai/api/v2/customtag) Custom Tag -------------------------------------------------------------- A custom tag for organizing and categorizing accounts and campaigns. You can use them as filters in apis that list accounts and campaigns. Operations post /api/v2/custom-tags get /api/v2/custom-tags get /api/v2/custom-tags/{id} patch /api/v2/custom-tags/{id} delete /api/v2/custom-tags/{id} post /api/v2/custom-tags/toggle-resource \+ Show [](https://developer.instantly.ai/api/v2/customtagmapping) Custom Tag Mapping ----------------------------------------------------------------------------- This entity represents a tag being assigned to a specific campaign or email account. When an email account is assigned a tag, a new custom tag mapping entry is created, which connects the tag (`tag_id` field) with the email account (`resource_id` field). You can use it to see which tag si connected to which resource. Operations get /api/v2/custom-tag-mappings \+ Show [](https://developer.instantly.ai/api/v2/blocklistentry) Block List Entry ------------------------------------------------------------------------- A blocked email or domain Operations post /api/v2/block-lists-entries get /api/v2/block-lists-entries get /api/v2/block-lists-entries/{id} patch /api/v2/block-lists-entries/{id} delete /api/v2/block-lists-entries/{id} \+ Show [](https://developer.instantly.ai/api/v2/leadlabel) Lead Label -------------------------------------------------------------- A custom label for categorizing and managing leads Operations post /api/v2/lead-labels get /api/v2/lead-labels get /api/v2/lead-labels/{id} patch /api/v2/lead-labels/{id} delete /api/v2/lead-labels/{id} post /api/v2/lead-labels/ai-reply-label \+ Show [](https://developer.instantly.ai/api/v2/workspace) Workspace ------------------------------------------------------------- A workspace entity representing a workspace Operations get /api/v2/workspaces/current patch /api/v2/workspaces/current post /api/v2/workspaces/current/whitelabel-domain get /api/v2/workspaces/current/whitelabel-domain delete /api/v2/workspaces/current/whitelabel-domain post /api/v2/workspaces/current/change-owner \+ Show [](https://developer.instantly.ai/api/v2/supersearchenrichment) SuperSearch Enrichment -------------------------------------------------------------------------------------- An enrichment can take different forms, such as email enrichment or LinkedIn enrichment. Leads may be imported from SuperSearch using the dedicated endpoint, or enriched directly within a list or campaign by attaching an enrichment to it. Operations post /api/v2/supersearch-enrichment/enrich-leads-from-supersearch get /api/v2/supersearch-enrichment/{resource\_id} post /api/v2/supersearch-enrichment patch /api/v2/supersearch-enrichment/{resource\_id}/settings post /api/v2/supersearch-enrichment/ai get /api/v2/supersearch-enrichment/ai/{resource\_id}/in-progress get /api/v2/supersearch-enrichment/history/{resource\_id} post /api/v2/supersearch-enrichment/runShow 2 more... \+ Show [](https://developer.instantly.ai/api/v2/workspacegroupmember) 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 post /api/v2/workspace-group-members get /api/v2/workspace-group-members get /api/v2/workspace-group-members/{id} delete /api/v2/workspace-group-members/{id} get /api/v2/workspace-group-members/admin \+ Show [](https://developer.instantly.ai/api/v2/workspacemember) Workspace Member -------------------------------------------------------------------------- A member of a workspace with associated user details Operations post /api/v2/workspace-members get /api/v2/workspace-members get /api/v2/workspace-members/{id} patch /api/v2/workspace-members/{id} delete /api/v2/workspace-members/{id} \+ Show [](https://developer.instantly.ai/api/v2/campaignsubsequence) Campaign Subsequence ---------------------------------------------------------------------------------- A subsequence entity representing a follow-up sequence Operations post /api/v2/subsequences get /api/v2/subsequences post /api/v2/subsequences/{id}/duplicate post /api/v2/subsequences/{id}/pause post /api/v2/subsequences/{id}/resume get /api/v2/subsequences/{id} patch /api/v2/subsequences/{id} delete /api/v2/subsequences/{id}Show 1 more... \+ Show [](https://developer.instantly.ai/api/v2/auditlog) Audit Log ------------------------------------------------------------ Audit log records for tracking system activities Operations get /api/v2/audit-logs \+ Show [](https://developer.instantly.ai/api/v2/webhook) Webhook --------------------------------------------------------- A webhook subscription for receiving event notifications Operations get /api/v2/webhooks post /api/v2/webhooks get /api/v2/webhooks/{id} patch /api/v2/webhooks/{id} delete /api/v2/webhooks/{id} get /api/v2/webhooks/event-types post /api/v2/webhooks/{id}/test post /api/v2/webhooks/{id}/resume \+ Show [](https://developer.instantly.ai/api/v2/webhookevent) Webhook Event -------------------------------------------------------------------- A webhook event that was sent or attempted to be sent Operations get /api/v2/webhook-events get /api/v2/webhook-events/{id} get /api/v2/webhook-events/summary get /api/v2/webhook-events/summary-by-date \+ Show [](https://developer.instantly.ai/api/v2/dfyemailaccountorder) DFY Email Account Order -------------------------------------------------------------------------------------- A Done-For-You email account order Operations post /api/v2/dfy-email-account-orders get /api/v2/dfy-email-account-orders post /api/v2/dfy-email-account-orders/domains/similar post /api/v2/dfy-email-account-orders/domains/check post /api/v2/dfy-email-account-orders/domains/pre-warmed-up-list get /api/v2/dfy-email-account-orders/accounts post /api/v2/dfy-email-account-orders/accounts/cancel \+ Show [](https://developer.instantly.ai/api/v2/customprompttemplate) Custom Prompt Template ------------------------------------------------------------------------------------- Custom prompt templates for creating custom prompts \+ Show [](https://developer.instantly.ai/api/v2/salesflow) Sales Flow -------------------------------------------------------------- Manages how sales users view and interact with campaign and lead lists within the sales flow. \+ Show [](https://developer.instantly.ai/api/v2/emailtemplate) Email Template ---------------------------------------------------------------------- A campaign email template \+ Show [](https://developer.instantly.ai/api/v2/workspacebilling) Workspace Billing ---------------------------------------------------------------------------- Workspace Billing Operations get /api/v2/workspace-billing/plan-details get /api/v2/workspace-billing/subscription-details \+ Show [](https://developer.instantly.ai/api/v2/crmactions) CRM Actions ---------------------------------------------------------------- CRM related actions Operations get /api/v2/crm-actions/phone-numbers delete /api/v2/crm-actions/phone-numbers/{id} \+ Show [](https://developer.instantly.ai/api/v2/schemas) Schemas --------------------------------------------------------- \+ Show --- # CRM Actions [Schemas](https://developer.instantly.ai/api/v2/schemas) / CRM Actions 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/ [](https://developer.instantly.ai/api/v2/analytics) Analytics ------------------------------------------------------------- Endpoints related to analytics Operations post /api/v2/accounts/warmup-analytics get /api/v2/accounts/analytics/daily post /api/v2/accounts/test/vitals get /api/v2/campaigns/analytics get /api/v2/campaigns/analytics/overview get /api/v2/campaigns/analytics/daily get /api/v2/campaigns/analytics/steps \+ Show [](https://developer.instantly.ai/api/v2/oauth) OAuth ----------------------------------------------------- OAuth authentication endpoints for connecting Google and Microsoft email accounts Operations post /api/v2/oauth/google/init post /api/v2/oauth/microsoft/init get /api/v2/oauth/session/status/{sessionId} \+ Show [](https://developer.instantly.ai/api/v2/account) Account --------------------------------------------------------- An email account that can be used to send campaigns Operations post /api/v2/accounts get /api/v2/accounts get /api/v2/accounts/{email} patch /api/v2/accounts/{email} delete /api/v2/accounts/{email} post /api/v2/accounts/warmup/enable post /api/v2/accounts/warmup/disable post /api/v2/accounts/warmup-analyticsShow 7 more... \+ Show [](https://developer.instantly.ai/api/v2/campaign) Campaign ----------------------------------------------------------- A campaign that can be sent to a list of recipients Operations post /api/v2/campaigns get /api/v2/campaigns post /api/v2/campaigns/{id}/activate post /api/v2/campaigns/{id}/pause get /api/v2/campaigns/{id} patch /api/v2/campaigns/{id} delete /api/v2/campaigns/{id} get /api/v2/campaigns/search-by-contactShow 11 more... \+ Show [](https://developer.instantly.ai/api/v2/email) Email ----------------------------------------------------- A campaign email, a reply, a manually sent email, or any other email that's visible in the Unibox Operations post /api/v2/emails/reply post /api/v2/emails/forward get /api/v2/emails get /api/v2/emails/{id} patch /api/v2/emails/{id} delete /api/v2/emails/{id} get /api/v2/emails/unread/count post /api/v2/emails/threads/{thread\_id}/mark-as-read \+ Show [](https://developer.instantly.ai/api/v2/emailverification) Email Verification ------------------------------------------------------------------------------ A single email verification Operations post /api/v2/email-verification get /api/v2/email-verification/{email} \+ Show [](https://developer.instantly.ai/api/v2/leadlist) Lead List ------------------------------------------------------------ A list used to store leads Operations post /api/v2/lead-lists get /api/v2/lead-lists get /api/v2/lead-lists/{id} patch /api/v2/lead-lists/{id} delete /api/v2/lead-lists/{id} get /api/v2/lead-lists/{id}/verification-stats \+ Show [](https://developer.instantly.ai/api/v2/inboxplacementtest) Inbox Placement Test --------------------------------------------------------------------------------- An inbox placement test Operations post /api/v2/inbox-placement-tests get /api/v2/inbox-placement-tests get /api/v2/inbox-placement-tests/{id} delete /api/v2/inbox-placement-tests/{id} patch /api/v2/inbox-placement-tests/{id} get /api/v2/inbox-placement-tests/email-service-provider-options \+ Show [](https://developer.instantly.ai/api/v2/inboxplacementanalytics) Inbox Placement Analytics ------------------------------------------------------------------------------------------- Analytics data for individual emails in inbox placement tests Operations get /api/v2/inbox-placement-analytics get /api/v2/inbox-placement-analytics/{id} post /api/v2/inbox-placement-analytics/stats-by-test-id post /api/v2/inbox-placement-analytics/deliverability-insights post /api/v2/inbox-placement-analytics/stats-by-date \+ Show [](https://developer.instantly.ai/api/v2/inboxplacementblacklistandspamassassinreport) Inbox Placement Blacklist & SpamAssassin Report -------------------------------------------------------------------------------------------------------------------------------------- Report data for an inbox placement test Operations get /api/v2/inbox-placement-reports get /api/v2/inbox-placement-reports/{id} \+ Show [](https://developer.instantly.ai/api/v2/apikey) API Key -------------------------------------------------------- API Key Operations post /api/v2/api-keys get /api/v2/api-keys delete /api/v2/api-keys/{id} \+ Show [](https://developer.instantly.ai/api/v2/accountcampaignmapping) Account Campaign Mapping ----------------------------------------------------------------------------------------- Account Campaign Mapping Operations get /api/v2/account-campaign-mappings/{email} \+ Show [](https://developer.instantly.ai/api/v2/lead) Lead --------------------------------------------------- A lead entity representing an individual lead Operations post /api/v2/leads delete /api/v2/leads post /api/v2/leads/list get /api/v2/leads/{id} patch /api/v2/leads/{id} delete /api/v2/leads/{id} post /api/v2/leads/merge post /api/v2/leads/update-interest-statusShow 5 more... \+ Show [](https://developer.instantly.ai/api/v2/backgroundjob) Background Job ---------------------------------------------------------------------- A background job that can be used to perform long-running tasks Operations get /api/v2/background-jobs get /api/v2/background-jobs/{id} \+ Show [](https://developer.instantly.ai/api/v2/customtag) Custom Tag -------------------------------------------------------------- A custom tag for organizing and categorizing accounts and campaigns. You can use them as filters in apis that list accounts and campaigns. Operations post /api/v2/custom-tags get /api/v2/custom-tags get /api/v2/custom-tags/{id} patch /api/v2/custom-tags/{id} delete /api/v2/custom-tags/{id} post /api/v2/custom-tags/toggle-resource \+ Show [](https://developer.instantly.ai/api/v2/customtagmapping) Custom Tag Mapping ----------------------------------------------------------------------------- This entity represents a tag being assigned to a specific campaign or email account. When an email account is assigned a tag, a new custom tag mapping entry is created, which connects the tag (`tag_id` field) with the email account (`resource_id` field). You can use it to see which tag si connected to which resource. Operations get /api/v2/custom-tag-mappings \+ Show [](https://developer.instantly.ai/api/v2/blocklistentry) Block List Entry ------------------------------------------------------------------------- A blocked email or domain Operations post /api/v2/block-lists-entries get /api/v2/block-lists-entries get /api/v2/block-lists-entries/{id} patch /api/v2/block-lists-entries/{id} delete /api/v2/block-lists-entries/{id} \+ Show [](https://developer.instantly.ai/api/v2/leadlabel) Lead Label -------------------------------------------------------------- A custom label for categorizing and managing leads Operations post /api/v2/lead-labels get /api/v2/lead-labels get /api/v2/lead-labels/{id} patch /api/v2/lead-labels/{id} delete /api/v2/lead-labels/{id} post /api/v2/lead-labels/ai-reply-label \+ Show [](https://developer.instantly.ai/api/v2/workspace) Workspace ------------------------------------------------------------- A workspace entity representing a workspace Operations get /api/v2/workspaces/current patch /api/v2/workspaces/current post /api/v2/workspaces/current/whitelabel-domain get /api/v2/workspaces/current/whitelabel-domain delete /api/v2/workspaces/current/whitelabel-domain post /api/v2/workspaces/current/change-owner \+ Show [](https://developer.instantly.ai/api/v2/supersearchenrichment) SuperSearch Enrichment -------------------------------------------------------------------------------------- An enrichment can take different forms, such as email enrichment or LinkedIn enrichment. Leads may be imported from SuperSearch using the dedicated endpoint, or enriched directly within a list or campaign by attaching an enrichment to it. Operations post /api/v2/supersearch-enrichment/enrich-leads-from-supersearch get /api/v2/supersearch-enrichment/{resource\_id} post /api/v2/supersearch-enrichment patch /api/v2/supersearch-enrichment/{resource\_id}/settings post /api/v2/supersearch-enrichment/ai get /api/v2/supersearch-enrichment/ai/{resource\_id}/in-progress get /api/v2/supersearch-enrichment/history/{resource\_id} post /api/v2/supersearch-enrichment/runShow 2 more... \+ Show [](https://developer.instantly.ai/api/v2/workspacegroupmember) 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 post /api/v2/workspace-group-members get /api/v2/workspace-group-members get /api/v2/workspace-group-members/{id} delete /api/v2/workspace-group-members/{id} get /api/v2/workspace-group-members/admin \+ Show [](https://developer.instantly.ai/api/v2/workspacemember) Workspace Member -------------------------------------------------------------------------- A member of a workspace with associated user details Operations post /api/v2/workspace-members get /api/v2/workspace-members get /api/v2/workspace-members/{id} patch /api/v2/workspace-members/{id} delete /api/v2/workspace-members/{id} \+ Show [](https://developer.instantly.ai/api/v2/campaignsubsequence) Campaign Subsequence ---------------------------------------------------------------------------------- A subsequence entity representing a follow-up sequence Operations post /api/v2/subsequences get /api/v2/subsequences post /api/v2/subsequences/{id}/duplicate post /api/v2/subsequences/{id}/pause post /api/v2/subsequences/{id}/resume get /api/v2/subsequences/{id} patch /api/v2/subsequences/{id} delete /api/v2/subsequences/{id}Show 1 more... \+ Show [](https://developer.instantly.ai/api/v2/auditlog) Audit Log ------------------------------------------------------------ Audit log records for tracking system activities Operations get /api/v2/audit-logs \+ Show [](https://developer.instantly.ai/api/v2/webhook) Webhook --------------------------------------------------------- A webhook subscription for receiving event notifications Operations get /api/v2/webhooks post /api/v2/webhooks get /api/v2/webhooks/{id} patch /api/v2/webhooks/{id} delete /api/v2/webhooks/{id} get /api/v2/webhooks/event-types post /api/v2/webhooks/{id}/test post /api/v2/webhooks/{id}/resume \+ Show [](https://developer.instantly.ai/api/v2/webhookevent) Webhook Event -------------------------------------------------------------------- A webhook event that was sent or attempted to be sent Operations get /api/v2/webhook-events get /api/v2/webhook-events/{id} get /api/v2/webhook-events/summary get /api/v2/webhook-events/summary-by-date \+ Show [](https://developer.instantly.ai/api/v2/dfyemailaccountorder) DFY Email Account Order -------------------------------------------------------------------------------------- A Done-For-You email account order Operations post /api/v2/dfy-email-account-orders get /api/v2/dfy-email-account-orders post /api/v2/dfy-email-account-orders/domains/similar post /api/v2/dfy-email-account-orders/domains/check post /api/v2/dfy-email-account-orders/domains/pre-warmed-up-list get /api/v2/dfy-email-account-orders/accounts post /api/v2/dfy-email-account-orders/accounts/cancel \+ Show [](https://developer.instantly.ai/api/v2/customprompttemplate) Custom Prompt Template ------------------------------------------------------------------------------------- Custom prompt templates for creating custom prompts \+ Show [](https://developer.instantly.ai/api/v2/salesflow) Sales Flow -------------------------------------------------------------- Manages how sales users view and interact with campaign and lead lists within the sales flow. \+ Show [](https://developer.instantly.ai/api/v2/emailtemplate) Email Template ---------------------------------------------------------------------- A campaign email template \+ Show [](https://developer.instantly.ai/api/v2/workspacebilling) Workspace Billing ---------------------------------------------------------------------------- Workspace Billing Operations get /api/v2/workspace-billing/plan-details get /api/v2/workspace-billing/subscription-details \+ Show [](https://developer.instantly.ai/api/v2/crmactions) CRM Actions ---------------------------------------------------------------- CRM related actions Operations get /api/v2/crm-actions/phone-numbers delete /api/v2/crm-actions/phone-numbers/{id} \+ Show [](https://developer.instantly.ai/api/v2/schemas) Schemas --------------------------------------------------------- [](https://developer.instantly.ai/api/v2/schemas/def-48) Workspace Billing -------------------------------------------------------------------------- Workspace Billing _object__(Workspace Billing)_ Workspace Billing {} [](https://developer.instantly.ai/api/v2/schemas/def-49) CRM Actions -------------------------------------------------------------------- CRM related actions _object__(CRM Actions)_ CRM related actions {} --- # Analytics [Analytics](https://developer.instantly.ai/api/v2/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/ [](https://developer.instantly.ai/api/v2/analytics) Analytics ------------------------------------------------------------- Endpoints related to analytics Operations post /api/v2/accounts/warmup-analytics get /api/v2/accounts/analytics/daily post /api/v2/accounts/test/vitals get /api/v2/campaigns/analytics get /api/v2/campaigns/analytics/overview get /api/v2/campaigns/analytics/daily get /api/v2/campaigns/analytics/steps [](https://developer.instantly.ai/api/v2/analytics/getwarmupanalytics) Get warmup analytics ------------------------------------------------------------------------------------------- #### [](https://developer.instantly.ai/api/v2/analytics/getwarmupanalytics#analytics/getwarmupanalytics/request) Request Requires one of the following scopes: `accounts:read`, `accounts:all`, `all:read`, `all:all` Security: ApiKeyAuth [](https://developer.instantly.ai/api/v2/analytics/getwarmupanalytics#analytics/getwarmupanalytics/request/body) Bodyapplication/jsonrequired [](https://developer.instantly.ai/api/v2/analytics/getwarmupanalytics#analytics/getwarmupanalytics/t=request&path=emails) emails_Array of strings__\[ 1 .. 100 \] items_required List of emails to get warmup analytics for. The emails should be attached to accounts in your workspace. Example: \["user@example.com"\] post /api/v2/accounts/warmup-analytics * Instantly API Server https://api.instantly.ai/api/v2/accounts/warmup-analytics * Mock server https://developer.instantly.ai/\_mock/api/v2/api/v2/accounts/warmup-analytics curl * curl * JavaScript * Node.js * Python * Java * C# * PHP * Go * Ruby * R * Payload curl -i -X POST \\ https://api.instantly.ai/api/v2/accounts/warmup-analytics \\ -H 'Authorization: Bearer ' \\ -H 'Content-Type: application/json' \\ -d '{ "emails": \[\ "user@example.com"\ \] }' Try it #### [](https://developer.instantly.ai/api/v2/analytics/getwarmupanalytics#analytics/getwarmupanalytics/response&c=200) Responses 1. 200 2. 401 3. 429 Expand all Default Response [](https://developer.instantly.ai/api/v2/analytics/getwarmupanalytics#analytics/getwarmupanalytics/response&c=200/body) Bodyapplication/json [](https://developer.instantly.ai/api/v2/analytics/getwarmupanalytics#analytics/getwarmupanalytics/t=response&c=200&path=email_date_data) email\_date\_data_object_ 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}}} +Show property [](https://developer.instantly.ai/api/v2/analytics/getwarmupanalytics#analytics/getwarmupanalytics/t=response&c=200&path=aggregate_data) aggregate\_data_object_ 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}} +Show property Response 1. 200 2. 401 3. 429 application/json { "email\_date\_data": { "example1@example.com": { … }, "example2@example.com": { … } }, "aggregate\_data": { "example1@example.com": { … }, "example2@example.com": { … } } } #### Was this helpful? [](https://developer.instantly.ai/api/v2/analytics/getdailyaccountanalytics) Get daily account analytics -------------------------------------------------------------------------------------------------------- #### [](https://developer.instantly.ai/api/v2/analytics/getdailyaccountanalytics#analytics/getdailyaccountanalytics/request) Request Get daily account analytics showing the number of emails sent per day for each email account. Useful for tracking daily sending activity across your accounts. Security: ApiKeyAuth [](https://developer.instantly.ai/api/v2/analytics/getdailyaccountanalytics#analytics/getdailyaccountanalytics/request/query) Query [](https://developer.instantly.ai/api/v2/analytics/getdailyaccountanalytics#analytics/getdailyaccountanalytics/t=request&in=query&path=start_date) start\_date_string_ Start date for the analytics period (optional). If not provided, returns data for the last 30 days. Example: start\_date=2024-01-01 [](https://developer.instantly.ai/api/v2/analytics/getdailyaccountanalytics#analytics/getdailyaccountanalytics/t=request&in=query&path=end_date) end\_date_string_ End date for the analytics period (optional). If not provided, defaults to current date. Example: end\_date=2024-01-31 [](https://developer.instantly.ai/api/v2/analytics/getdailyaccountanalytics#analytics/getdailyaccountanalytics/t=request&in=query&path=emails) emails_Array of strings_ Filter by specific email accounts (optional). If not provided, returns data for all accounts in your workspace. Example: emails=user@example.com get /api/v2/accounts/analytics/daily * Instantly API Server https://api.instantly.ai/api/v2/accounts/analytics/daily * Mock server https://developer.instantly.ai/\_mock/api/v2/api/v2/accounts/analytics/daily curl * curl * JavaScript * Node.js * Python * Java * C# * PHP * Go * Ruby * R * Payload curl -i -X GET \\ 'https://api.instantly.ai/api/v2/accounts/analytics/daily?emails=user%40example.com&end\_date=2024-01-31&start\_date=2024-01-01' \\ -H 'Authorization: Bearer ' Try it #### [](https://developer.instantly.ai/api/v2/analytics/getdailyaccountanalytics#analytics/getdailyaccountanalytics/response&c=200) Responses 1. 200 2. 400 3. 401 4. 429 Default Response [](https://developer.instantly.ai/api/v2/analytics/getdailyaccountanalytics#analytics/getdailyaccountanalytics/response&c=200/body) Bodyapplication/jsonArray \[\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailyaccountanalytics#analytics/getdailyaccountanalytics/t=response&c=200&path=date)\ date_string_required\ \ The date of the analytics entry, in YYYY-MM-DD format\ \ Example: "2024-01-15"\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailyaccountanalytics#analytics/getdailyaccountanalytics/t=response&c=200&path=email_account)\ email\_account_string_required\ \ The email account that sent the emails\ \ Example: "user@example.com"\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailyaccountanalytics#analytics/getdailyaccountanalytics/t=response&c=200&path=sent)\ sent_integer_required\ \ The total number of campaign emails sent on this date by this account, including emails for subsequences\ \ Example: 150\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailyaccountanalytics#analytics/getdailyaccountanalytics/t=response&c=200&path=bounced)\ bounced_integer_required\ \ The number of emails that bounced on this date for this account for campaigns - including subsequences\ \ Example: 3\ \ \] Response 1. 200 2. 400 3. 401 4. 429 application/json \[\ {\ "date": "2024-01-15",\ "email\_account": "user@example.com",\ "sent": 150,\ "bounced": 3\ }\ \] #### Was this helpful? [](https://developer.instantly.ai/api/v2/analytics/testaccountvitals) Test account vitals ----------------------------------------------------------------------------------------- #### [](https://developer.instantly.ai/api/v2/analytics/testaccountvitals#analytics/testaccountvitals/request) Request Requires one of the following scopes: `accounts:read`, `accounts:all`, `all:read`, `all:all` Security: ApiKeyAuth [](https://developer.instantly.ai/api/v2/analytics/testaccountvitals#analytics/testaccountvitals/request/body) Bodyapplication/json [](https://developer.instantly.ai/api/v2/analytics/testaccountvitals#analytics/testaccountvitals/t=request&path=accounts) accounts_Array of strings_ Example: \["user@example.com"\] post /api/v2/accounts/test/vitals * Instantly API Server https://api.instantly.ai/api/v2/accounts/test/vitals * Mock server https://developer.instantly.ai/\_mock/api/v2/api/v2/accounts/test/vitals curl * curl * JavaScript * Node.js * Python * Java * C# * PHP * Go * Ruby * R * Payload curl -i -X POST \\ https://api.instantly.ai/api/v2/accounts/test/vitals \\ -H 'Authorization: Bearer ' \\ -H 'Content-Type: application/json' \\ -d '{}' Try it #### [](https://developer.instantly.ai/api/v2/analytics/testaccountvitals#analytics/testaccountvitals/response&c=200) Responses 1. 200 2. 400 3. 401 4. 429 Expand all Default Response [](https://developer.instantly.ai/api/v2/analytics/testaccountvitals#analytics/testaccountvitals/response&c=200/body) Bodyapplication/json [](https://developer.instantly.ai/api/v2/analytics/testaccountvitals#analytics/testaccountvitals/t=response&c=200&path=status) status_string_ Example: "success" [](https://developer.instantly.ai/api/v2/analytics/testaccountvitals#analytics/testaccountvitals/t=response&c=200&path=success_list) success\_list_Array of objects_ +Show 6 array properties [](https://developer.instantly.ai/api/v2/analytics/testaccountvitals#analytics/testaccountvitals/t=response&c=200&path=failure_list) failure\_list_Array of objects_ +Show 6 array properties Response 1. 200 2. 400 3. 401 4. 429 application/json { "status": "success", "success\_list": \[\ { … }\ \], "failure\_list": \[\ { … }\ \] } #### Was this helpful? [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics) Get campaign(s) analytics -------------------------------------------------------------------------------------------------- #### [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/request) 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 Security: ApiKeyAuth [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/request/query) Query [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=request&in=query&path=id) id_string__(uuid)_ A campaign ID to get the analytics for. Leave this field empty to get the analytics for all campaigns Example: id=019c9b71-ee3b-70c6-8e78-b4aa88251a46 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=request&in=query&path=ids) ids_Array of strings__(uuid)_ Example: ids=019c9b71-ee3b-70c6-8e78-b4abfdb12c1c [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=request&in=query&path=start_date) start\_date_string_ Start date Example: start\_date=2024-01-01 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=request&in=query&path=end_date) end\_date_string_ End date Example: end\_date=2024-01-01 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=request&in=query&path=exclude_total_leads_count) exclude\_total\_leads\_count_boolean_ Exclude the total leads from the result. Setting this to true will considerably decrease the response time Default false Example: exclude\_total\_leads\_count=true get /api/v2/campaigns/analytics * Instantly API Server https://api.instantly.ai/api/v2/campaigns/analytics * Mock server https://developer.instantly.ai/\_mock/api/v2/api/v2/campaigns/analytics curl * curl * JavaScript * Node.js * Python * Java * C# * PHP * Go * Ruby * R * Payload curl -i -X GET \\ 'https://api.instantly.ai/api/v2/campaigns/analytics?end\_date=2024-01-01&exclude\_total\_leads\_count=true&id=019c9b71-ee3b-70c6-8e78-b4aa88251a46&ids=019c9b71-ee3b-70c6-8e78-b4abfdb12c1c&start\_date=2024-01-01' \\ -H 'Authorization: Bearer ' Try it #### [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/response&c=200) Responses 1. 200 2. 400 3. 401 4. 404 5. 429 Default Response [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/response&c=200/body) Bodyapplication/jsonArray \[\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=campaign_name)\ campaign\_name_string_required\ \ The name of the campaign\ \ Example: "My Test Campaign"\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=campaign_id)\ campaign\_id_string__(uuid)_required\ \ The ID of the campaign\ \ Example: "019c9b71-ee3b-70c6-8e78-b4ac05ee54ba"\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=campaign_status)\ campaign\_status_number_required\ \ The campaign status\ \ | Enum Value | Description |\ | --- | --- |\ | 0 | Draft |\ | 1 | Active |\ | 2 | Paused |\ | 3 | Completed |\ | 4 | Running Subsequences |\ | \-99 | Account Suspended |\ | \-1 | Accounts Unhealthy |\ | \-2 | Bounce Protect |\ \ Example: 1\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=campaign_is_evergreen)\ campaign\_is\_evergreen_boolean_required\ \ Whether the campaign is evergreen\ \ Example: true\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=leads_count)\ leads\_count_integer_required\ \ The total number of leads\ \ Example: 1500\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=contacted_count)\ contacted\_count_integer_required\ \ Number of leads for whom the sequence has started\ \ Example: 1200\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=open_count)\ open\_count_integer_required\ \ The number of leads that opened at least one email\ \ Example: 800\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=reply_count)\ reply\_count_integer_required\ \ The total number of replies received (if a lead replies multiple times, each reply is counted)\ \ Example: 300\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=link_click_count)\ link\_click\_count_integer_required\ \ The number of links that got clicked\ \ Example: 800\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=bounced_count)\ bounced\_count_integer_required\ \ The number of bounced leads\ \ Example: 50\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=unsubscribed_count)\ unsubscribed\_count_integer_required\ \ The number of unsubscribed leads\ \ Example: 20\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=completed_count)\ completed\_count_integer_required\ \ The number of leads that the campaign was completed for\ \ Example: 1100\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=emails_sent_count)\ emails\_sent\_count_integer_required\ \ The total number of sent emails\ \ Example: 5000\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=new_leads_contacted_count)\ new\_leads\_contacted\_count_integer_required\ \ The total number of new leads contacted\ \ Example: 200\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=total_opportunities)\ total\_opportunities_integer_required\ \ The total number of unique opportunities created\ \ Example: 10\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=total_opportunity_value)\ total\_opportunity\_value_number_required\ \ The total value of opportunities created\ \ Example: 1000\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=open_count_unique)\ open\_count\_unique_integer_\ \ The number of unique email opens (first open per lead)\ \ Example: 750\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=open_count_unique_by_step)\ open\_count\_unique\_by\_step_integer_\ \ The number of unique email opens per step (first open per lead per step)\ \ Example: 900\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=reply_count_unique)\ reply\_count\_unique_integer_\ \ The number of unique replies (first reply per lead). Excludes automatic replies.\ \ Example: 280\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=reply_count_unique_by_step)\ reply\_count\_unique\_by\_step_integer_\ \ The number of unique replies per step (first reply per lead per step). Excludes automatic replies.\ \ Example: 350\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=reply_count_automatic)\ reply\_count\_automatic_integer_\ \ The total number of automatic replies detected\ \ Example: 15\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=reply_count_automatic_unique)\ reply\_count\_automatic\_unique_integer_\ \ The number of unique automatic replies (first automatic reply per lead)\ \ Example: 12\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=reply_count_automatic_unique_by_step)\ reply\_count\_automatic\_unique\_by\_step_integer_\ \ The number of unique automatic replies per step\ \ Example: 18\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=link_click_count_unique)\ link\_click\_count\_unique_integer_\ \ The number of unique link clicks (first click per lead)\ \ Example: 600\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=link_click_count_unique_by_step)\ link\_click\_count\_unique\_by\_step_integer_\ \ The number of unique link clicks per step (first click per lead per step)\ \ Example: 720\ \ \] Response 1. 200 2. 400 3. 401 4. 404 5. 429 application/json \[\ {\ "campaign\_name": "My Test Campaign",\ "campaign\_id": "019c9b71-ee3b-70c6-8e78-b4ac05ee54ba",\ "campaign\_status": 1,\ "campaign\_is\_evergreen": true,\ "leads\_count": 1500,\ "contacted\_count": 1200,\ "emails\_sent\_count": 5000,\ "new\_leads\_contacted\_count": 200,\ "open\_count": 800,\ "open\_count\_unique": 750,\ "open\_count\_unique\_by\_step": 900,\ "reply\_count": 300,\ "reply\_count\_unique": 280,\ "reply\_count\_unique\_by\_step": 350,\ "reply\_count\_automatic": 15,\ "reply\_count\_automatic\_unique": 12,\ "reply\_count\_automatic\_unique\_by\_step": 18,\ "link\_click\_count": 800,\ "link\_click\_count\_unique": 600,\ "link\_click\_count\_unique\_by\_step": 720,\ "bounced\_count": 50,\ "unsubscribed\_count": 20,\ "completed\_count": 1100,\ "total\_opportunities": 10,\ "total\_opportunity\_value": 1000\ }\ \] #### Was this helpful? [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview) Get campaign(s) analytics overview ------------------------------------------------------------------------------------------------------------------- #### [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/request) Request 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. Security: ApiKeyAuth [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/request/query) Query [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=request&in=query&path=id) id_string__(uuid)_ A campaign ID to get the analytics overview for. Leave this field empty to get the analytics overview for all campaigns Example: id=019c9b71-ee3b-70c6-8e78-b4ad08832181 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=request&in=query&path=ids) ids_Array of strings__(uuid)_ Example: ids=019c9b71-ee3c-7ffc-873f-f9193acd9a12 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=request&in=query&path=start_date) start\_date_string_ Start date Example: start\_date=2024-01-01 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=request&in=query&path=end_date) end\_date_string_ End date Example: end\_date=2024-01-01 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=request&in=query&path=campaign_status) campaign\_status_number_ 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 | Example: campaign\_status=1 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=request&in=query&path=expand_crm_events) expand\_crm\_events_boolean_ 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). Default false Example: expand\_crm\_events=true get /api/v2/campaigns/analytics/overview * Instantly API Server https://api.instantly.ai/api/v2/campaigns/analytics/overview * Mock server https://developer.instantly.ai/\_mock/api/v2/api/v2/campaigns/analytics/overview curl * curl * JavaScript * Node.js * Python * Java * C# * PHP * Go * Ruby * R * Payload 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=019c9b71-ee3b-70c6-8e78-b4ad08832181&ids=019c9b71-ee3c-7ffc-873f-f9193acd9a12&start\_date=2024-01-01' \\ -H 'Authorization: Bearer ' Try it #### [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/response&c=200) Responses 1. 200 2. 400 3. 401 4. 404 5. 429 Default Response [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/response&c=200/body) Bodyapplication/json [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=open_count) open\_count_integer_ The total number of times the emails were opened, including duplicates Example: 800 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=open_count_unique) open\_count\_unique_integer_ The number of emails that got opened (for the first time only) Example: 800 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=open_count_unique_by_step) open\_count\_unique\_by\_step_integer_ The unique number of times the emails were opened (counted once per lead, step, and campaign) Example: 800 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=link_click_count) link\_click\_count_integer_ The number of links that got clicked Example: 800 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=link_click_count_unique) link\_click\_count\_unique_integer_ The number of links that got clicked (for the first time) Example: 800 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=link_click_count_unique_by_step) link\_click\_count\_unique\_by\_step_integer_ The unique number of links that got clicked, per step (counted once per lead, step, and campaign) Example: 800 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=reply_count) reply\_count_integer_ The total number of replies received (if a lead replies multiple times, each reply is counted) Example: 300 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=reply_count_unique) reply\_count\_unique_integer_ The number of unique replies (first reply per lead). Excludes automatic replies. Example: 300 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=reply_count_unique_by_step) reply\_count\_unique\_by\_step_integer_ The number of unique replies per step (first reply per lead per step). Excludes automatic replies. Example: 300 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=reply_count_automatic) reply\_count\_automatic_integer_ The total number of automatic replies received (e.g., out-of-office) Example: 50 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=reply_count_automatic_unique) reply\_count\_automatic\_unique_integer_ The number of unique leads that sent automatic replies Example: 45 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=reply_count_automatic_unique_by_step) reply\_count\_automatic\_unique\_by\_step_integer_ The unique number of automatic replies per step (counted once per lead, step, and campaign) Example: 45 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=bounced_count) bounced\_count_integer_ The number of bounced leads Example: 50 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=unsubscribed_count) unsubscribed\_count_integer_ The number of unsubscribed leads Example: 20 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=completed_count) completed\_count_integer_ The number of leads that the campaign was completed for Example: 1100 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=emails_sent_count) emails\_sent\_count_integer_ The total number of sent emails Example: 5000 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=contacted_count) contacted\_count_integer_ The total number of unique leads contacted Example: 4500 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=new_leads_contacted_count) new\_leads\_contacted\_count_integer_ The total number of new leads contacted Example: 200 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=total_opportunities) total\_opportunities_integer_ The total number of unique opportunities created Example: 10 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=total_opportunity_value) total\_opportunity\_value_number_ The total value of opportunities created Example: 1000 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=total_interested) total\_interested_integer_ The total number of interested opportunities created Example: 103 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=total_meeting_booked) total\_meeting\_booked_integer_ The total number of meeting booked opportunities created Example: 45 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=total_meeting_completed) total\_meeting\_completed_integer_ The total number of meeting completed opportunities created Example: 12 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=total_closed) total\_closed_integer_ The total number of closed opportunities created Example: 10 Response 1. 200 2. 400 3. 401 4. 404 5. 429 application/json { "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, "reply\_count\_automatic": 50, "reply\_count\_automatic\_unique": 45, "reply\_count\_automatic\_unique\_by\_step": 45, "bounced\_count": 50, "unsubscribed\_count": 20, "completed\_count": 1100, "emails\_sent\_count": 5000, "contacted\_count": 4500, "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 } #### Was this helpful? [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics) Get daily campaign analytics ---------------------------------------------------------------------------------------------------------- #### [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/request) Request Get campaign daily analytics Security: ApiKeyAuth [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/request/query) Query [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=request&in=query&path=campaign_id) campaign\_id_string__(uuid)_ Campaign ID (optional). Leave this field empty to get the analytics for all campaigns Example: campaign\_id=019c9b71-ee3c-7ffc-873f-f91a3db506d7 [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=request&in=query&path=start_date) start\_date_string_ Start date Example: start\_date=2024-01-01 [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=request&in=query&path=end_date) end\_date_string_ End date Example: end\_date=2024-01-01 [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=request&in=query&path=campaign_status) campaign\_status_number_ 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 | Example: campaign\_status=1 get /api/v2/campaigns/analytics/daily * Instantly API Server https://api.instantly.ai/api/v2/campaigns/analytics/daily * Mock server https://developer.instantly.ai/\_mock/api/v2/api/v2/campaigns/analytics/daily curl * curl * JavaScript * Node.js * Python * Java * C# * PHP * Go * Ruby * R * Payload curl -i -X GET \\ 'https://api.instantly.ai/api/v2/campaigns/analytics/daily?campaign\_id=019c9b71-ee3c-7ffc-873f-f91a3db506d7&campaign\_status=1&end\_date=2024-01-01&start\_date=2024-01-01' \\ -H 'Authorization: Bearer ' Try it #### [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/response&c=200) Responses 1. 200 2. 400 3. 401 4. 404 5. 429 Default Response [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/response&c=200/body) Bodyapplication/jsonArray \[\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=response&c=200&path=date)\ date_string_\ \ The date of the analytics entry, in YYYY-MM-DD format\ \ Example: "2025-03-01"\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=response&c=200&path=sent)\ sent_integer_\ \ The total number of sent emails\ \ Example: 5421\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=response&c=200&path=contacted)\ contacted_integer_\ \ The total number of unique contacts who received an email that day\ \ Example: 5000\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=response&c=200&path=new_leads_contacted)\ new\_leads\_contacted_integer_\ \ The total number of new leads contacted that day\ \ Example: 200\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=response&c=200&path=opened)\ opened_integer_\ \ The total number of opened emails\ \ Example: 99\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=response&c=200&path=unique_opened)\ unique\_opened_integer_\ \ The total number of unique opened emails\ \ Example: 60\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=response&c=200&path=replies)\ replies_integer_\ \ The total number of replies\ \ Example: 60\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=response&c=200&path=unique_replies)\ unique\_replies_integer_\ \ The total number of unique replies\ \ Example: 60\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=response&c=200&path=replies_automatic)\ replies\_automatic_integer_\ \ The total number of automatic replies detected\ \ Example: 5\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=response&c=200&path=unique_replies_automatic)\ unique\_replies\_automatic_integer_\ \ The total number of unique automatic replies detected\ \ Example: 4\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=response&c=200&path=clicks)\ clicks_integer_\ \ The total number of links clicked\ \ Example: 60\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=response&c=200&path=unique_clicks)\ unique\_clicks_integer_\ \ The total number of unique links clicked. Unique meaning from unique leads, not unique links. For instance, if a lead clicked a link 3 times, it will be counted as 1 unique click. If a lead clicked 3 different links, it will still be counted as 1 unique click\ \ Example: 60\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=response&c=200&path=opportunities)\ opportunities_integer_\ \ The total number of unique opportunities created from the campaign on that day\ \ Example: 5\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=response&c=200&path=unique_opportunities)\ unique\_opportunities_integer_\ \ The total number of unique opportunities created from unique leads from the campaign on that day\ \ Example: 3\ \ \] Response 1. 200 2. 400 3. 401 4. 404 5. 429 application/json \[\ {\ "date": "2025-03-01",\ "sent": 5421,\ "contacted": 5000,\ "new\_leads\_contacted": 200,\ "opened": 99,\ "unique\_opened": 60,\ "replies": 60,\ "unique\_replies": 60,\ "replies\_automatic": 5,\ "unique\_replies\_automatic": 4,\ "clicks": 60,\ "unique\_clicks": 60,\ "opportunities": 5,\ "unique\_opportunities": 3\ }\ \] #### Was this helpful? [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics) Get campaign steps analytics ---------------------------------------------------------------------------------------------------------- #### [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/request) Request Get campaign steps analytics Security: ApiKeyAuth [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/request/query) Query [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=request&in=query&path=campaign_id) campaign\_id_string__(uuid)_ Campaign ID (optional). Leave this field empty to get the analytics for all campaigns Example: campaign\_id=019c9b71-ee3d-7db5-8ef1-69bed0cb34fc [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=request&in=query&path=start_date) start\_date_string_ Start date Example: start\_date=2024-01-01 [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=request&in=query&path=end_date) end\_date_string_ End date Example: end\_date=2024-01-01 [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=request&in=query&path=include_opportunities_count) include\_opportunities\_count_boolean_ Whether to include the opportunities count per step. If this field is true then `opportunities` and `unique_opportunities` fields will be included in the response Default false Example: include\_opportunities\_count=true get /api/v2/campaigns/analytics/steps * Instantly API Server https://api.instantly.ai/api/v2/campaigns/analytics/steps * Mock server https://developer.instantly.ai/\_mock/api/v2/api/v2/campaigns/analytics/steps curl * curl * JavaScript * Node.js * Python * Java * C# * PHP * Go * Ruby * R * Payload curl -i -X GET \\ 'https://api.instantly.ai/api/v2/campaigns/analytics/steps?campaign\_id=019c9b71-ee3d-7db5-8ef1-69bed0cb34fc&end\_date=2024-01-01&include\_opportunities\_count=true&start\_date=2024-01-01' \\ -H 'Authorization: Bearer ' Try it #### [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/response&c=200) Responses 1. 200 2. 400 3. 401 4. 404 5. 429 Default Response [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/response&c=200/body) Bodyapplication/jsonArray \[\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=response&c=200&path=step)\ step_null or string_required\ \ The step number. When null it means we couldn't determine the step number for the event, for instance for list leads, which are not part of a campaign.\ \ Example: "1"\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=response&c=200&path=variant)\ variant_null or string_required\ \ The variant number, starting from 0. 0 = A, 1 = B, 2 = C, etc. When null it means we couldn't determine the variant for the event.\ \ Example: "0"\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=response&c=200&path=sent)\ sent_integer_required\ \ The total number of sent emails\ \ Example: 5421\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=response&c=200&path=opened)\ opened_integer_required\ \ The total number of opened emails\ \ Example: 99\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=response&c=200&path=unique_opened)\ unique\_opened_integer_required\ \ The total number of opened emails\ \ Example: 60\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=response&c=200&path=replies)\ replies_integer_required\ \ The total number of replies\ \ Example: 60\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=response&c=200&path=unique_replies)\ unique\_replies_integer_required\ \ The total number of replies\ \ Example: 60\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=response&c=200&path=replies_automatic)\ replies\_automatic_integer_required\ \ The total number of automatic replies detected\ \ Example: 5\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=response&c=200&path=unique_replies_automatic)\ unique\_replies\_automatic_integer_required\ \ The total number of unique automatic replies detected\ \ Example: 4\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=response&c=200&path=clicks)\ clicks_integer_required\ \ The total number of links clicked\ \ Example: 60\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=response&c=200&path=unique_clicks)\ unique\_clicks_integer_required\ \ The total number of unique links clicked. Unique meaning from unique leads, not unique links. For instance, if a lead clicked a link 3 times, it will be counted as 1 unique click. If a lead clicked 3 different links, it will still be counted as 1 unique click\ \ Example: 60\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=response&c=200&path=opportunities)\ opportunities_integer_\ \ The total number of opportunities created from this step. Included only if `include_opportunities_count` is `true`\ \ Example: 10\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=response&c=200&path=unique_opportunities)\ unique\_opportunities_integer_\ \ The total number of unique opportunities created from this step. Unique meaning unique per lead. If a lead has multiple opportunities, it will be counted as 1 unique opportunity. Included only if `include_opportunities_count` is `true`\ \ Example: 8\ \ \] Response 1. 200 2. 400 3. 401 4. 404 5. 429 application/json \[\ {\ "step": "1",\ "variant": "0",\ "sent": 5421,\ "opened": 99,\ "unique\_opened": 60,\ "replies": 60,\ "unique\_replies": 60,\ "replies\_automatic": 5,\ "unique\_replies\_automatic": 4,\ "clicks": 60,\ "unique\_clicks": 60,\ "opportunities": 10,\ "unique\_opportunities": 8\ }\ \] #### Was this helpful? [](https://developer.instantly.ai/api/v2/oauth) OAuth ----------------------------------------------------- OAuth authentication endpoints for connecting Google and Microsoft email accounts Operations post /api/v2/oauth/google/init post /api/v2/oauth/microsoft/init get /api/v2/oauth/session/status/{sessionId} \+ Show [](https://developer.instantly.ai/api/v2/account) Account --------------------------------------------------------- An email account that can be used to send campaigns Operations post /api/v2/accounts get /api/v2/accounts get /api/v2/accounts/{email} patch /api/v2/accounts/{email} delete /api/v2/accounts/{email} post /api/v2/accounts/warmup/enable post /api/v2/accounts/warmup/disable post /api/v2/accounts/warmup-analyticsShow 7 more... \+ Show [](https://developer.instantly.ai/api/v2/campaign) Campaign ----------------------------------------------------------- A campaign that can be sent to a list of recipients Operations post /api/v2/campaigns get /api/v2/campaigns post /api/v2/campaigns/{id}/activate post /api/v2/campaigns/{id}/pause get /api/v2/campaigns/{id} patch /api/v2/campaigns/{id} delete /api/v2/campaigns/{id} get /api/v2/campaigns/search-by-contactShow 11 more... \+ Show [](https://developer.instantly.ai/api/v2/email) Email ----------------------------------------------------- A campaign email, a reply, a manually sent email, or any other email that's visible in the Unibox Operations post /api/v2/emails/reply post /api/v2/emails/forward get /api/v2/emails get /api/v2/emails/{id} patch /api/v2/emails/{id} delete /api/v2/emails/{id} get /api/v2/emails/unread/count post /api/v2/emails/threads/{thread\_id}/mark-as-read \+ Show [](https://developer.instantly.ai/api/v2/emailverification) Email Verification ------------------------------------------------------------------------------ A single email verification Operations post /api/v2/email-verification get /api/v2/email-verification/{email} \+ Show [](https://developer.instantly.ai/api/v2/leadlist) Lead List ------------------------------------------------------------ A list used to store leads Operations post /api/v2/lead-lists get /api/v2/lead-lists get /api/v2/lead-lists/{id} patch /api/v2/lead-lists/{id} delete /api/v2/lead-lists/{id} get /api/v2/lead-lists/{id}/verification-stats \+ Show [](https://developer.instantly.ai/api/v2/inboxplacementtest) Inbox Placement Test --------------------------------------------------------------------------------- An inbox placement test Operations post /api/v2/inbox-placement-tests get /api/v2/inbox-placement-tests get /api/v2/inbox-placement-tests/{id} delete /api/v2/inbox-placement-tests/{id} patch /api/v2/inbox-placement-tests/{id} get /api/v2/inbox-placement-tests/email-service-provider-options \+ Show [](https://developer.instantly.ai/api/v2/inboxplacementanalytics) Inbox Placement Analytics ------------------------------------------------------------------------------------------- Analytics data for individual emails in inbox placement tests Operations get /api/v2/inbox-placement-analytics get /api/v2/inbox-placement-analytics/{id} post /api/v2/inbox-placement-analytics/stats-by-test-id post /api/v2/inbox-placement-analytics/deliverability-insights post /api/v2/inbox-placement-analytics/stats-by-date \+ Show [](https://developer.instantly.ai/api/v2/inboxplacementblacklistandspamassassinreport) Inbox Placement Blacklist & SpamAssassin Report -------------------------------------------------------------------------------------------------------------------------------------- Report data for an inbox placement test Operations get /api/v2/inbox-placement-reports get /api/v2/inbox-placement-reports/{id} \+ Show [](https://developer.instantly.ai/api/v2/apikey) API Key -------------------------------------------------------- API Key Operations post /api/v2/api-keys get /api/v2/api-keys delete /api/v2/api-keys/{id} \+ Show [](https://developer.instantly.ai/api/v2/accountcampaignmapping) Account Campaign Mapping ----------------------------------------------------------------------------------------- Account Campaign Mapping Operations get /api/v2/account-campaign-mappings/{email} \+ Show [](https://developer.instantly.ai/api/v2/lead) Lead --------------------------------------------------- A lead entity representing an individual lead Operations post /api/v2/leads delete /api/v2/leads post /api/v2/leads/list get /api/v2/leads/{id} patch /api/v2/leads/{id} delete /api/v2/leads/{id} post /api/v2/leads/merge post /api/v2/leads/update-interest-statusShow 5 more... \+ Show [](https://developer.instantly.ai/api/v2/backgroundjob) Background Job ---------------------------------------------------------------------- A background job that can be used to perform long-running tasks Operations get /api/v2/background-jobs get /api/v2/background-jobs/{id} \+ Show [](https://developer.instantly.ai/api/v2/customtag) Custom Tag -------------------------------------------------------------- A custom tag for organizing and categorizing accounts and campaigns. You can use them as filters in apis that list accounts and campaigns. Operations post /api/v2/custom-tags get /api/v2/custom-tags get /api/v2/custom-tags/{id} patch /api/v2/custom-tags/{id} delete /api/v2/custom-tags/{id} post /api/v2/custom-tags/toggle-resource \+ Show [](https://developer.instantly.ai/api/v2/customtagmapping) Custom Tag Mapping ----------------------------------------------------------------------------- This entity represents a tag being assigned to a specific campaign or email account. When an email account is assigned a tag, a new custom tag mapping entry is created, which connects the tag (`tag_id` field) with the email account (`resource_id` field). You can use it to see which tag si connected to which resource. Operations get /api/v2/custom-tag-mappings \+ Show [](https://developer.instantly.ai/api/v2/blocklistentry) Block List Entry ------------------------------------------------------------------------- A blocked email or domain Operations post /api/v2/block-lists-entries get /api/v2/block-lists-entries get /api/v2/block-lists-entries/{id} patch /api/v2/block-lists-entries/{id} delete /api/v2/block-lists-entries/{id} \+ Show [](https://developer.instantly.ai/api/v2/leadlabel) Lead Label -------------------------------------------------------------- A custom label for categorizing and managing leads Operations post /api/v2/lead-labels get /api/v2/lead-labels get /api/v2/lead-labels/{id} patch /api/v2/lead-labels/{id} delete /api/v2/lead-labels/{id} post /api/v2/lead-labels/ai-reply-label \+ Show [](https://developer.instantly.ai/api/v2/workspace) Workspace ------------------------------------------------------------- A workspace entity representing a workspace Operations get /api/v2/workspaces/current patch /api/v2/workspaces/current post /api/v2/workspaces/current/whitelabel-domain get /api/v2/workspaces/current/whitelabel-domain delete /api/v2/workspaces/current/whitelabel-domain post /api/v2/workspaces/current/change-owner \+ Show [](https://developer.instantly.ai/api/v2/supersearchenrichment) SuperSearch Enrichment -------------------------------------------------------------------------------------- An enrichment can take different forms, such as email enrichment or LinkedIn enrichment. Leads may be imported from SuperSearch using the dedicated endpoint, or enriched directly within a list or campaign by attaching an enrichment to it. Operations post /api/v2/supersearch-enrichment/enrich-leads-from-supersearch get /api/v2/supersearch-enrichment/{resource\_id} post /api/v2/supersearch-enrichment patch /api/v2/supersearch-enrichment/{resource\_id}/settings post /api/v2/supersearch-enrichment/ai get /api/v2/supersearch-enrichment/ai/{resource\_id}/in-progress get /api/v2/supersearch-enrichment/history/{resource\_id} post /api/v2/supersearch-enrichment/runShow 2 more... \+ Show [](https://developer.instantly.ai/api/v2/workspacegroupmember) 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 post /api/v2/workspace-group-members get /api/v2/workspace-group-members get /api/v2/workspace-group-members/{id} delete /api/v2/workspace-group-members/{id} get /api/v2/workspace-group-members/admin \+ Show [](https://developer.instantly.ai/api/v2/workspacemember) Workspace Member -------------------------------------------------------------------------- A member of a workspace with associated user details Operations post /api/v2/workspace-members get /api/v2/workspace-members get /api/v2/workspace-members/{id} patch /api/v2/workspace-members/{id} delete /api/v2/workspace-members/{id} \+ Show [](https://developer.instantly.ai/api/v2/campaignsubsequence) Campaign Subsequence ---------------------------------------------------------------------------------- A subsequence entity representing a follow-up sequence Operations post /api/v2/subsequences get /api/v2/subsequences post /api/v2/subsequences/{id}/duplicate post /api/v2/subsequences/{id}/pause post /api/v2/subsequences/{id}/resume get /api/v2/subsequences/{id} patch /api/v2/subsequences/{id} delete /api/v2/subsequences/{id}Show 1 more... \+ Show [](https://developer.instantly.ai/api/v2/auditlog) Audit Log ------------------------------------------------------------ Audit log records for tracking system activities Operations get /api/v2/audit-logs \+ Show [](https://developer.instantly.ai/api/v2/webhook) Webhook --------------------------------------------------------- A webhook subscription for receiving event notifications Operations get /api/v2/webhooks post /api/v2/webhooks get /api/v2/webhooks/{id} patch /api/v2/webhooks/{id} delete /api/v2/webhooks/{id} get /api/v2/webhooks/event-types post /api/v2/webhooks/{id}/test post /api/v2/webhooks/{id}/resume \+ Show [](https://developer.instantly.ai/api/v2/webhookevent) Webhook Event -------------------------------------------------------------------- A webhook event that was sent or attempted to be sent Operations get /api/v2/webhook-events get /api/v2/webhook-events/{id} get /api/v2/webhook-events/summary get /api/v2/webhook-events/summary-by-date \+ Show [](https://developer.instantly.ai/api/v2/dfyemailaccountorder) DFY Email Account Order -------------------------------------------------------------------------------------- A Done-For-You email account order Operations post /api/v2/dfy-email-account-orders get /api/v2/dfy-email-account-orders post /api/v2/dfy-email-account-orders/domains/similar post /api/v2/dfy-email-account-orders/domains/check post /api/v2/dfy-email-account-orders/domains/pre-warmed-up-list get /api/v2/dfy-email-account-orders/accounts post /api/v2/dfy-email-account-orders/accounts/cancel \+ Show [](https://developer.instantly.ai/api/v2/customprompttemplate) Custom Prompt Template ------------------------------------------------------------------------------------- Custom prompt templates for creating custom prompts \+ Show [](https://developer.instantly.ai/api/v2/salesflow) Sales Flow -------------------------------------------------------------- Manages how sales users view and interact with campaign and lead lists within the sales flow. \+ Show [](https://developer.instantly.ai/api/v2/emailtemplate) Email Template ---------------------------------------------------------------------- A campaign email template \+ Show [](https://developer.instantly.ai/api/v2/workspacebilling) Workspace Billing ---------------------------------------------------------------------------- Workspace Billing Operations get /api/v2/workspace-billing/plan-details get /api/v2/workspace-billing/subscription-details \+ Show [](https://developer.instantly.ai/api/v2/crmactions) CRM Actions ---------------------------------------------------------------- CRM related actions Operations get /api/v2/crm-actions/phone-numbers delete /api/v2/crm-actions/phone-numbers/{id} \+ Show [](https://developer.instantly.ai/api/v2/schemas) Schemas --------------------------------------------------------- \+ Show --- # Initialize google oauth [OAuth](https://developer.instantly.ai/api/v2/oauth) / Initialize google oauth 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/ [](https://developer.instantly.ai/api/v2/analytics) Analytics ------------------------------------------------------------- Endpoints related to analytics Operations post /api/v2/accounts/warmup-analytics get /api/v2/accounts/analytics/daily post /api/v2/accounts/test/vitals get /api/v2/campaigns/analytics get /api/v2/campaigns/analytics/overview get /api/v2/campaigns/analytics/daily get /api/v2/campaigns/analytics/steps \+ Show [](https://developer.instantly.ai/api/v2/oauth) OAuth ----------------------------------------------------- OAuth authentication endpoints for connecting Google and Microsoft email accounts Operations post /api/v2/oauth/google/init post /api/v2/oauth/microsoft/init get /api/v2/oauth/session/status/{sessionId} [](https://developer.instantly.ai/api/v2/oauth/initgoogleoauth) Initialize google oauth --------------------------------------------------------------------------------------- #### [](https://developer.instantly.ai/api/v2/oauth/initgoogleoauth#oauth/initgoogleoauth/request) Request Creates an OAuth session and returns the Google authorization URL. The user should be redirected to auth\_url to complete the OAuth flow. Poll the status endpoint to check for completion. Security: ApiKeyAuth post /api/v2/oauth/google/init * Instantly API Server https://api.instantly.ai/api/v2/oauth/google/init * Mock server https://developer.instantly.ai/\_mock/api/v2/api/v2/oauth/google/init curl * curl * JavaScript * Node.js * Python * Java * C# * PHP * Go * Ruby * R * Payload curl -i -X POST \\ https://api.instantly.ai/api/v2/oauth/google/init \\ -H 'Authorization: Bearer ' Try it #### [](https://developer.instantly.ai/api/v2/oauth/initgoogleoauth#oauth/initgoogleoauth/response&c=200) Responses 1. 200 Default Response [](https://developer.instantly.ai/api/v2/oauth/initgoogleoauth#oauth/initgoogleoauth/response&c=200/body) Bodyapplication/json [](https://developer.instantly.ai/api/v2/oauth/initgoogleoauth#oauth/initgoogleoauth/t=response&c=200&path=session_id) session\_id_string_ Session ID for polling status Example: "abc123def456" [](https://developer.instantly.ai/api/v2/oauth/initgoogleoauth#oauth/initgoogleoauth/t=response&c=200&path=auth_url) auth\_url_string_ Google authorization URL to redirect user to Example: "https://accounts.google.com/o/oauth2/auth?..." [](https://developer.instantly.ai/api/v2/oauth/initgoogleoauth#oauth/initgoogleoauth/t=response&c=200&path=expires_at) expires\_at_string__(date-time)_ Session expiry time (10 minutes from creation) Example: "2026-01-14T12:30:00.000Z" Response 1. 200 application/json { "session\_id": "abc123def456", "auth\_url": "https://accounts.google.com/o/oauth2/auth?...", "expires\_at": "2026-01-14T12:30:00.000Z" } #### Was this helpful? [](https://developer.instantly.ai/api/v2/oauth/initmicrosoftoauth) Initialize microsoft oauth --------------------------------------------------------------------------------------------- #### [](https://developer.instantly.ai/api/v2/oauth/initmicrosoftoauth#oauth/initmicrosoftoauth/request) Request Creates an OAuth session and returns the Microsoft authorization URL. The user should be redirected to auth\_url to complete the OAuth flow. Poll the status endpoint to check for completion. Security: ApiKeyAuth post /api/v2/oauth/microsoft/init * Instantly API Server https://api.instantly.ai/api/v2/oauth/microsoft/init * Mock server https://developer.instantly.ai/\_mock/api/v2/api/v2/oauth/microsoft/init curl * curl * JavaScript * Node.js * Python * Java * C# * PHP * Go * Ruby * R * Payload curl -i -X POST \\ https://api.instantly.ai/api/v2/oauth/microsoft/init \\ -H 'Authorization: Bearer ' Try it #### [](https://developer.instantly.ai/api/v2/oauth/initmicrosoftoauth#oauth/initmicrosoftoauth/response&c=200) Responses 1. 200 Default Response [](https://developer.instantly.ai/api/v2/oauth/initmicrosoftoauth#oauth/initmicrosoftoauth/response&c=200/body) Bodyapplication/json [](https://developer.instantly.ai/api/v2/oauth/initmicrosoftoauth#oauth/initmicrosoftoauth/t=response&c=200&path=session_id) session\_id_string_ Session ID for polling status Example: "abc123def456" [](https://developer.instantly.ai/api/v2/oauth/initmicrosoftoauth#oauth/initmicrosoftoauth/t=response&c=200&path=auth_url) auth\_url_string_ Microsoft authorization URL to redirect user to Example: "https://login.microsoftonline.com/common/oauth2/v2.0/authorize?..." [](https://developer.instantly.ai/api/v2/oauth/initmicrosoftoauth#oauth/initmicrosoftoauth/t=response&c=200&path=expires_at) expires\_at_string__(date-time)_ Session expiry time (10 minutes from creation) Example: "2026-01-14T12:30:00.000Z" Response 1. 200 application/json { "session\_id": "abc123def456", "auth\_url": "https://login.microsoftonline.com/common/oauth2/v2.0/authorize?...", "expires\_at": "2026-01-14T12:30:00.000Z" } #### Was this helpful? [](https://developer.instantly.ai/api/v2/oauth/getoauthsessionstatus) Get oauth session status ---------------------------------------------------------------------------------------------- #### [](https://developer.instantly.ai/api/v2/oauth/getoauthsessionstatus#oauth/getoauthsessionstatus/request) Request Poll this endpoint to check the OAuth session result. Works for both Google and Microsoft OAuth sessions. Returns pending while waiting, success with account details when complete, or error if something went wrong. Sessions expire after 10 minutes. Security: ApiKeyAuth [](https://developer.instantly.ai/api/v2/oauth/getoauthsessionstatus#oauth/getoauthsessionstatus/request/path) Path [](https://developer.instantly.ai/api/v2/oauth/getoauthsessionstatus#oauth/getoauthsessionstatus/t=request&in=path&path=sessionid) sessionId_string_required Session ID from init response Example: abc123def456 get /api/v2/oauth/session/status/{sessionId} * Instantly API Server https://api.instantly.ai/api/v2/oauth/session/status/{sessionId} * Mock server https://developer.instantly.ai/\_mock/api/v2/api/v2/oauth/session/status/{sessionId} curl * curl * JavaScript * Node.js * Python * Java * C# * PHP * Go * Ruby * R * Payload curl -i -X GET \\ https://api.instantly.ai/api/v2/oauth/session/status/abc123def456 \\ -H 'Authorization: Bearer ' Try it #### [](https://developer.instantly.ai/api/v2/oauth/getoauthsessionstatus#oauth/getoauthsessionstatus/response&c=200) Responses 1. 200 Default Response [](https://developer.instantly.ai/api/v2/oauth/getoauthsessionstatus#oauth/getoauthsessionstatus/response&c=200/body) Bodyapplication/json [](https://developer.instantly.ai/api/v2/oauth/getoauthsessionstatus#oauth/getoauthsessionstatus/t=response&c=200&path=status) status_string_ Current status of the OAuth session Enum"pending""success""error""expired" Example: "success" [](https://developer.instantly.ai/api/v2/oauth/getoauthsessionstatus#oauth/getoauthsessionstatus/t=response&c=200&path=email) email_string_ Email of the connected account (on success) Example: "user@example.com" [](https://developer.instantly.ai/api/v2/oauth/getoauthsessionstatus#oauth/getoauthsessionstatus/t=response&c=200&path=name) name_string_ Name of the account owner (on success) Example: "John Doe" [](https://developer.instantly.ai/api/v2/oauth/getoauthsessionstatus#oauth/getoauthsessionstatus/t=response&c=200&path=error) error_string_ Error code (on error) Example: "access\_denied" [](https://developer.instantly.ai/api/v2/oauth/getoauthsessionstatus#oauth/getoauthsessionstatus/t=response&c=200&path=error_description) error\_description_string_ Human-readable error description (on error) Example: "User denied access to the application" Response 1. 200 application/json { "status": "success", "email": "user@example.com", "name": "John Doe", "error": "access\_denied", "error\_description": "User denied access to the application" } #### Was this helpful? [](https://developer.instantly.ai/api/v2/account) Account --------------------------------------------------------- An email account that can be used to send campaigns Operations post /api/v2/accounts get /api/v2/accounts get /api/v2/accounts/{email} patch /api/v2/accounts/{email} delete /api/v2/accounts/{email} post /api/v2/accounts/warmup/enable post /api/v2/accounts/warmup/disable post /api/v2/accounts/warmup-analyticsShow 7 more... \+ Show [](https://developer.instantly.ai/api/v2/campaign) Campaign ----------------------------------------------------------- A campaign that can be sent to a list of recipients Operations post /api/v2/campaigns get /api/v2/campaigns post /api/v2/campaigns/{id}/activate post /api/v2/campaigns/{id}/pause get /api/v2/campaigns/{id} patch /api/v2/campaigns/{id} delete /api/v2/campaigns/{id} get /api/v2/campaigns/search-by-contactShow 11 more... \+ Show [](https://developer.instantly.ai/api/v2/email) Email ----------------------------------------------------- A campaign email, a reply, a manually sent email, or any other email that's visible in the Unibox Operations post /api/v2/emails/reply post /api/v2/emails/forward get /api/v2/emails get /api/v2/emails/{id} patch /api/v2/emails/{id} delete /api/v2/emails/{id} get /api/v2/emails/unread/count post /api/v2/emails/threads/{thread\_id}/mark-as-read \+ Show [](https://developer.instantly.ai/api/v2/emailverification) Email Verification ------------------------------------------------------------------------------ A single email verification Operations post /api/v2/email-verification get /api/v2/email-verification/{email} \+ Show [](https://developer.instantly.ai/api/v2/leadlist) Lead List ------------------------------------------------------------ A list used to store leads Operations post /api/v2/lead-lists get /api/v2/lead-lists get /api/v2/lead-lists/{id} patch /api/v2/lead-lists/{id} delete /api/v2/lead-lists/{id} get /api/v2/lead-lists/{id}/verification-stats \+ Show [](https://developer.instantly.ai/api/v2/inboxplacementtest) Inbox Placement Test --------------------------------------------------------------------------------- An inbox placement test Operations post /api/v2/inbox-placement-tests get /api/v2/inbox-placement-tests get /api/v2/inbox-placement-tests/{id} delete /api/v2/inbox-placement-tests/{id} patch /api/v2/inbox-placement-tests/{id} get /api/v2/inbox-placement-tests/email-service-provider-options \+ Show [](https://developer.instantly.ai/api/v2/inboxplacementanalytics) Inbox Placement Analytics ------------------------------------------------------------------------------------------- Analytics data for individual emails in inbox placement tests Operations get /api/v2/inbox-placement-analytics get /api/v2/inbox-placement-analytics/{id} post /api/v2/inbox-placement-analytics/stats-by-test-id post /api/v2/inbox-placement-analytics/deliverability-insights post /api/v2/inbox-placement-analytics/stats-by-date \+ Show [](https://developer.instantly.ai/api/v2/inboxplacementblacklistandspamassassinreport) Inbox Placement Blacklist & SpamAssassin Report -------------------------------------------------------------------------------------------------------------------------------------- Report data for an inbox placement test Operations get /api/v2/inbox-placement-reports get /api/v2/inbox-placement-reports/{id} \+ Show [](https://developer.instantly.ai/api/v2/apikey) API Key -------------------------------------------------------- API Key Operations post /api/v2/api-keys get /api/v2/api-keys delete /api/v2/api-keys/{id} \+ Show [](https://developer.instantly.ai/api/v2/accountcampaignmapping) Account Campaign Mapping ----------------------------------------------------------------------------------------- Account Campaign Mapping Operations get /api/v2/account-campaign-mappings/{email} \+ Show [](https://developer.instantly.ai/api/v2/lead) Lead --------------------------------------------------- A lead entity representing an individual lead Operations post /api/v2/leads delete /api/v2/leads post /api/v2/leads/list get /api/v2/leads/{id} patch /api/v2/leads/{id} delete /api/v2/leads/{id} post /api/v2/leads/merge post /api/v2/leads/update-interest-statusShow 5 more... \+ Show [](https://developer.instantly.ai/api/v2/backgroundjob) Background Job ---------------------------------------------------------------------- A background job that can be used to perform long-running tasks Operations get /api/v2/background-jobs get /api/v2/background-jobs/{id} \+ Show [](https://developer.instantly.ai/api/v2/customtag) Custom Tag -------------------------------------------------------------- A custom tag for organizing and categorizing accounts and campaigns. You can use them as filters in apis that list accounts and campaigns. Operations post /api/v2/custom-tags get /api/v2/custom-tags get /api/v2/custom-tags/{id} patch /api/v2/custom-tags/{id} delete /api/v2/custom-tags/{id} post /api/v2/custom-tags/toggle-resource \+ Show [](https://developer.instantly.ai/api/v2/customtagmapping) Custom Tag Mapping ----------------------------------------------------------------------------- This entity represents a tag being assigned to a specific campaign or email account. When an email account is assigned a tag, a new custom tag mapping entry is created, which connects the tag (`tag_id` field) with the email account (`resource_id` field). You can use it to see which tag si connected to which resource. Operations get /api/v2/custom-tag-mappings \+ Show [](https://developer.instantly.ai/api/v2/blocklistentry) Block List Entry ------------------------------------------------------------------------- A blocked email or domain Operations post /api/v2/block-lists-entries get /api/v2/block-lists-entries get /api/v2/block-lists-entries/{id} patch /api/v2/block-lists-entries/{id} delete /api/v2/block-lists-entries/{id} \+ Show [](https://developer.instantly.ai/api/v2/leadlabel) Lead Label -------------------------------------------------------------- A custom label for categorizing and managing leads Operations post /api/v2/lead-labels get /api/v2/lead-labels get /api/v2/lead-labels/{id} patch /api/v2/lead-labels/{id} delete /api/v2/lead-labels/{id} post /api/v2/lead-labels/ai-reply-label \+ Show [](https://developer.instantly.ai/api/v2/workspace) Workspace ------------------------------------------------------------- A workspace entity representing a workspace Operations get /api/v2/workspaces/current patch /api/v2/workspaces/current post /api/v2/workspaces/current/whitelabel-domain get /api/v2/workspaces/current/whitelabel-domain delete /api/v2/workspaces/current/whitelabel-domain post /api/v2/workspaces/current/change-owner \+ Show [](https://developer.instantly.ai/api/v2/supersearchenrichment) SuperSearch Enrichment -------------------------------------------------------------------------------------- An enrichment can take different forms, such as email enrichment or LinkedIn enrichment. Leads may be imported from SuperSearch using the dedicated endpoint, or enriched directly within a list or campaign by attaching an enrichment to it. Operations post /api/v2/supersearch-enrichment/enrich-leads-from-supersearch get /api/v2/supersearch-enrichment/{resource\_id} post /api/v2/supersearch-enrichment patch /api/v2/supersearch-enrichment/{resource\_id}/settings post /api/v2/supersearch-enrichment/ai get /api/v2/supersearch-enrichment/ai/{resource\_id}/in-progress get /api/v2/supersearch-enrichment/history/{resource\_id} post /api/v2/supersearch-enrichment/runShow 2 more... \+ Show [](https://developer.instantly.ai/api/v2/workspacegroupmember) 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 post /api/v2/workspace-group-members get /api/v2/workspace-group-members get /api/v2/workspace-group-members/{id} delete /api/v2/workspace-group-members/{id} get /api/v2/workspace-group-members/admin \+ Show [](https://developer.instantly.ai/api/v2/workspacemember) Workspace Member -------------------------------------------------------------------------- A member of a workspace with associated user details Operations post /api/v2/workspace-members get /api/v2/workspace-members get /api/v2/workspace-members/{id} patch /api/v2/workspace-members/{id} delete /api/v2/workspace-members/{id} \+ Show [](https://developer.instantly.ai/api/v2/campaignsubsequence) Campaign Subsequence ---------------------------------------------------------------------------------- A subsequence entity representing a follow-up sequence Operations post /api/v2/subsequences get /api/v2/subsequences post /api/v2/subsequences/{id}/duplicate post /api/v2/subsequences/{id}/pause post /api/v2/subsequences/{id}/resume get /api/v2/subsequences/{id} patch /api/v2/subsequences/{id} delete /api/v2/subsequences/{id}Show 1 more... \+ Show [](https://developer.instantly.ai/api/v2/auditlog) Audit Log ------------------------------------------------------------ Audit log records for tracking system activities Operations get /api/v2/audit-logs \+ Show [](https://developer.instantly.ai/api/v2/webhook) Webhook --------------------------------------------------------- A webhook subscription for receiving event notifications Operations get /api/v2/webhooks post /api/v2/webhooks get /api/v2/webhooks/{id} patch /api/v2/webhooks/{id} delete /api/v2/webhooks/{id} get /api/v2/webhooks/event-types post /api/v2/webhooks/{id}/test post /api/v2/webhooks/{id}/resume \+ Show [](https://developer.instantly.ai/api/v2/webhookevent) Webhook Event -------------------------------------------------------------------- A webhook event that was sent or attempted to be sent Operations get /api/v2/webhook-events get /api/v2/webhook-events/{id} get /api/v2/webhook-events/summary get /api/v2/webhook-events/summary-by-date \+ Show [](https://developer.instantly.ai/api/v2/dfyemailaccountorder) DFY Email Account Order -------------------------------------------------------------------------------------- A Done-For-You email account order Operations post /api/v2/dfy-email-account-orders get /api/v2/dfy-email-account-orders post /api/v2/dfy-email-account-orders/domains/similar post /api/v2/dfy-email-account-orders/domains/check post /api/v2/dfy-email-account-orders/domains/pre-warmed-up-list get /api/v2/dfy-email-account-orders/accounts post /api/v2/dfy-email-account-orders/accounts/cancel \+ Show [](https://developer.instantly.ai/api/v2/customprompttemplate) Custom Prompt Template ------------------------------------------------------------------------------------- Custom prompt templates for creating custom prompts \+ Show [](https://developer.instantly.ai/api/v2/salesflow) Sales Flow -------------------------------------------------------------- Manages how sales users view and interact with campaign and lead lists within the sales flow. \+ Show [](https://developer.instantly.ai/api/v2/emailtemplate) Email Template ---------------------------------------------------------------------- A campaign email template \+ Show [](https://developer.instantly.ai/api/v2/workspacebilling) Workspace Billing ---------------------------------------------------------------------------- Workspace Billing Operations get /api/v2/workspace-billing/plan-details get /api/v2/workspace-billing/subscription-details \+ Show [](https://developer.instantly.ai/api/v2/crmactions) CRM Actions ---------------------------------------------------------------- CRM related actions Operations get /api/v2/crm-actions/phone-numbers delete /api/v2/crm-actions/phone-numbers/{id} \+ Show [](https://developer.instantly.ai/api/v2/schemas) Schemas --------------------------------------------------------- \+ Show --- # Get campaign(s) analytics [Analytics](https://developer.instantly.ai/api/v2/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/ [](https://developer.instantly.ai/api/v2/analytics) Analytics ------------------------------------------------------------- Endpoints related to analytics Operations post /api/v2/accounts/warmup-analytics get /api/v2/accounts/analytics/daily post /api/v2/accounts/test/vitals get /api/v2/campaigns/analytics get /api/v2/campaigns/analytics/overview get /api/v2/campaigns/analytics/daily get /api/v2/campaigns/analytics/steps [](https://developer.instantly.ai/api/v2/analytics/getwarmupanalytics) Get warmup analytics ------------------------------------------------------------------------------------------- #### [](https://developer.instantly.ai/api/v2/analytics/getwarmupanalytics#analytics/getwarmupanalytics/request) Request Requires one of the following scopes: `accounts:read`, `accounts:all`, `all:read`, `all:all` Security: ApiKeyAuth [](https://developer.instantly.ai/api/v2/analytics/getwarmupanalytics#analytics/getwarmupanalytics/request/body) Bodyapplication/jsonrequired [](https://developer.instantly.ai/api/v2/analytics/getwarmupanalytics#analytics/getwarmupanalytics/t=request&path=emails) emails_Array of strings__\[ 1 .. 100 \] items_required List of emails to get warmup analytics for. The emails should be attached to accounts in your workspace. Example: \["user@example.com"\] post /api/v2/accounts/warmup-analytics * Instantly API Server https://api.instantly.ai/api/v2/accounts/warmup-analytics * Mock server https://developer.instantly.ai/\_mock/api/v2/api/v2/accounts/warmup-analytics curl * curl * JavaScript * Node.js * Python * Java * C# * PHP * Go * Ruby * R * Payload curl -i -X POST \\ https://api.instantly.ai/api/v2/accounts/warmup-analytics \\ -H 'Authorization: Bearer ' \\ -H 'Content-Type: application/json' \\ -d '{ "emails": \[\ "user@example.com"\ \] }' Try it #### [](https://developer.instantly.ai/api/v2/analytics/getwarmupanalytics#analytics/getwarmupanalytics/response&c=200) Responses 1. 200 2. 401 3. 429 Expand all Default Response [](https://developer.instantly.ai/api/v2/analytics/getwarmupanalytics#analytics/getwarmupanalytics/response&c=200/body) Bodyapplication/json [](https://developer.instantly.ai/api/v2/analytics/getwarmupanalytics#analytics/getwarmupanalytics/t=response&c=200&path=email_date_data) email\_date\_data_object_ 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}}} +Show property [](https://developer.instantly.ai/api/v2/analytics/getwarmupanalytics#analytics/getwarmupanalytics/t=response&c=200&path=aggregate_data) aggregate\_data_object_ 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}} +Show property Response 1. 200 2. 401 3. 429 application/json { "email\_date\_data": { "example1@example.com": { … }, "example2@example.com": { … } }, "aggregate\_data": { "example1@example.com": { … }, "example2@example.com": { … } } } #### Was this helpful? [](https://developer.instantly.ai/api/v2/analytics/getdailyaccountanalytics) Get daily account analytics -------------------------------------------------------------------------------------------------------- #### [](https://developer.instantly.ai/api/v2/analytics/getdailyaccountanalytics#analytics/getdailyaccountanalytics/request) Request Get daily account analytics showing the number of emails sent per day for each email account. Useful for tracking daily sending activity across your accounts. Security: ApiKeyAuth [](https://developer.instantly.ai/api/v2/analytics/getdailyaccountanalytics#analytics/getdailyaccountanalytics/request/query) Query [](https://developer.instantly.ai/api/v2/analytics/getdailyaccountanalytics#analytics/getdailyaccountanalytics/t=request&in=query&path=start_date) start\_date_string_ Start date for the analytics period (optional). If not provided, returns data for the last 30 days. Example: start\_date=2024-01-01 [](https://developer.instantly.ai/api/v2/analytics/getdailyaccountanalytics#analytics/getdailyaccountanalytics/t=request&in=query&path=end_date) end\_date_string_ End date for the analytics period (optional). If not provided, defaults to current date. Example: end\_date=2024-01-31 [](https://developer.instantly.ai/api/v2/analytics/getdailyaccountanalytics#analytics/getdailyaccountanalytics/t=request&in=query&path=emails) emails_Array of strings_ Filter by specific email accounts (optional). If not provided, returns data for all accounts in your workspace. Example: emails=user@example.com get /api/v2/accounts/analytics/daily * Instantly API Server https://api.instantly.ai/api/v2/accounts/analytics/daily * Mock server https://developer.instantly.ai/\_mock/api/v2/api/v2/accounts/analytics/daily curl * curl * JavaScript * Node.js * Python * Java * C# * PHP * Go * Ruby * R * Payload curl -i -X GET \\ 'https://api.instantly.ai/api/v2/accounts/analytics/daily?emails=user%40example.com&end\_date=2024-01-31&start\_date=2024-01-01' \\ -H 'Authorization: Bearer ' Try it #### [](https://developer.instantly.ai/api/v2/analytics/getdailyaccountanalytics#analytics/getdailyaccountanalytics/response&c=200) Responses 1. 200 2. 400 3. 401 4. 429 Default Response [](https://developer.instantly.ai/api/v2/analytics/getdailyaccountanalytics#analytics/getdailyaccountanalytics/response&c=200/body) Bodyapplication/jsonArray \[\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailyaccountanalytics#analytics/getdailyaccountanalytics/t=response&c=200&path=date)\ date_string_required\ \ The date of the analytics entry, in YYYY-MM-DD format\ \ Example: "2024-01-15"\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailyaccountanalytics#analytics/getdailyaccountanalytics/t=response&c=200&path=email_account)\ email\_account_string_required\ \ The email account that sent the emails\ \ Example: "user@example.com"\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailyaccountanalytics#analytics/getdailyaccountanalytics/t=response&c=200&path=sent)\ sent_integer_required\ \ The total number of campaign emails sent on this date by this account, including emails for subsequences\ \ Example: 150\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailyaccountanalytics#analytics/getdailyaccountanalytics/t=response&c=200&path=bounced)\ bounced_integer_required\ \ The number of emails that bounced on this date for this account for campaigns - including subsequences\ \ Example: 3\ \ \] Response 1. 200 2. 400 3. 401 4. 429 application/json \[\ {\ "date": "2024-01-15",\ "email\_account": "user@example.com",\ "sent": 150,\ "bounced": 3\ }\ \] #### Was this helpful? [](https://developer.instantly.ai/api/v2/analytics/testaccountvitals) Test account vitals ----------------------------------------------------------------------------------------- #### [](https://developer.instantly.ai/api/v2/analytics/testaccountvitals#analytics/testaccountvitals/request) Request Requires one of the following scopes: `accounts:read`, `accounts:all`, `all:read`, `all:all` Security: ApiKeyAuth [](https://developer.instantly.ai/api/v2/analytics/testaccountvitals#analytics/testaccountvitals/request/body) Bodyapplication/json [](https://developer.instantly.ai/api/v2/analytics/testaccountvitals#analytics/testaccountvitals/t=request&path=accounts) accounts_Array of strings_ Example: \["user@example.com"\] post /api/v2/accounts/test/vitals * Instantly API Server https://api.instantly.ai/api/v2/accounts/test/vitals * Mock server https://developer.instantly.ai/\_mock/api/v2/api/v2/accounts/test/vitals curl * curl * JavaScript * Node.js * Python * Java * C# * PHP * Go * Ruby * R * Payload curl -i -X POST \\ https://api.instantly.ai/api/v2/accounts/test/vitals \\ -H 'Authorization: Bearer ' \\ -H 'Content-Type: application/json' \\ -d '{}' Try it #### [](https://developer.instantly.ai/api/v2/analytics/testaccountvitals#analytics/testaccountvitals/response&c=200) Responses 1. 200 2. 400 3. 401 4. 429 Expand all Default Response [](https://developer.instantly.ai/api/v2/analytics/testaccountvitals#analytics/testaccountvitals/response&c=200/body) Bodyapplication/json [](https://developer.instantly.ai/api/v2/analytics/testaccountvitals#analytics/testaccountvitals/t=response&c=200&path=status) status_string_ Example: "success" [](https://developer.instantly.ai/api/v2/analytics/testaccountvitals#analytics/testaccountvitals/t=response&c=200&path=success_list) success\_list_Array of objects_ +Show 6 array properties [](https://developer.instantly.ai/api/v2/analytics/testaccountvitals#analytics/testaccountvitals/t=response&c=200&path=failure_list) failure\_list_Array of objects_ +Show 6 array properties Response 1. 200 2. 400 3. 401 4. 429 application/json { "status": "success", "success\_list": \[\ { … }\ \], "failure\_list": \[\ { … }\ \] } #### Was this helpful? [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics) Get campaign(s) analytics -------------------------------------------------------------------------------------------------- #### [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/request) 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 Security: ApiKeyAuth [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/request/query) Query [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=request&in=query&path=id) id_string__(uuid)_ A campaign ID to get the analytics for. Leave this field empty to get the analytics for all campaigns Example: id=019c9b71-ee3b-70c6-8e78-b4aa88251a46 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=request&in=query&path=ids) ids_Array of strings__(uuid)_ Example: ids=019c9b71-ee3b-70c6-8e78-b4abfdb12c1c [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=request&in=query&path=start_date) start\_date_string_ Start date Example: start\_date=2024-01-01 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=request&in=query&path=end_date) end\_date_string_ End date Example: end\_date=2024-01-01 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=request&in=query&path=exclude_total_leads_count) exclude\_total\_leads\_count_boolean_ Exclude the total leads from the result. Setting this to true will considerably decrease the response time Default false Example: exclude\_total\_leads\_count=true get /api/v2/campaigns/analytics * Instantly API Server https://api.instantly.ai/api/v2/campaigns/analytics * Mock server https://developer.instantly.ai/\_mock/api/v2/api/v2/campaigns/analytics curl * curl * JavaScript * Node.js * Python * Java * C# * PHP * Go * Ruby * R * Payload curl -i -X GET \\ 'https://api.instantly.ai/api/v2/campaigns/analytics?end\_date=2024-01-01&exclude\_total\_leads\_count=true&id=019c9b71-ee3b-70c6-8e78-b4aa88251a46&ids=019c9b71-ee3b-70c6-8e78-b4abfdb12c1c&start\_date=2024-01-01' \\ -H 'Authorization: Bearer ' Try it #### [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/response&c=200) Responses 1. 200 2. 400 3. 401 4. 404 5. 429 Default Response [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/response&c=200/body) Bodyapplication/jsonArray \[\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=campaign_name)\ campaign\_name_string_required\ \ The name of the campaign\ \ Example: "My Test Campaign"\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=campaign_id)\ campaign\_id_string__(uuid)_required\ \ The ID of the campaign\ \ Example: "019c9b71-ee3b-70c6-8e78-b4ac05ee54ba"\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=campaign_status)\ campaign\_status_number_required\ \ The campaign status\ \ | Enum Value | Description |\ | --- | --- |\ | 0 | Draft |\ | 1 | Active |\ | 2 | Paused |\ | 3 | Completed |\ | 4 | Running Subsequences |\ | \-99 | Account Suspended |\ | \-1 | Accounts Unhealthy |\ | \-2 | Bounce Protect |\ \ Example: 1\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=campaign_is_evergreen)\ campaign\_is\_evergreen_boolean_required\ \ Whether the campaign is evergreen\ \ Example: true\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=leads_count)\ leads\_count_integer_required\ \ The total number of leads\ \ Example: 1500\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=contacted_count)\ contacted\_count_integer_required\ \ Number of leads for whom the sequence has started\ \ Example: 1200\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=open_count)\ open\_count_integer_required\ \ The number of leads that opened at least one email\ \ Example: 800\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=reply_count)\ reply\_count_integer_required\ \ The total number of replies received (if a lead replies multiple times, each reply is counted)\ \ Example: 300\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=link_click_count)\ link\_click\_count_integer_required\ \ The number of links that got clicked\ \ Example: 800\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=bounced_count)\ bounced\_count_integer_required\ \ The number of bounced leads\ \ Example: 50\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=unsubscribed_count)\ unsubscribed\_count_integer_required\ \ The number of unsubscribed leads\ \ Example: 20\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=completed_count)\ completed\_count_integer_required\ \ The number of leads that the campaign was completed for\ \ Example: 1100\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=emails_sent_count)\ emails\_sent\_count_integer_required\ \ The total number of sent emails\ \ Example: 5000\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=new_leads_contacted_count)\ new\_leads\_contacted\_count_integer_required\ \ The total number of new leads contacted\ \ Example: 200\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=total_opportunities)\ total\_opportunities_integer_required\ \ The total number of unique opportunities created\ \ Example: 10\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=total_opportunity_value)\ total\_opportunity\_value_number_required\ \ The total value of opportunities created\ \ Example: 1000\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=open_count_unique)\ open\_count\_unique_integer_\ \ The number of unique email opens (first open per lead)\ \ Example: 750\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=open_count_unique_by_step)\ open\_count\_unique\_by\_step_integer_\ \ The number of unique email opens per step (first open per lead per step)\ \ Example: 900\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=reply_count_unique)\ reply\_count\_unique_integer_\ \ The number of unique replies (first reply per lead). Excludes automatic replies.\ \ Example: 280\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=reply_count_unique_by_step)\ reply\_count\_unique\_by\_step_integer_\ \ The number of unique replies per step (first reply per lead per step). Excludes automatic replies.\ \ Example: 350\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=reply_count_automatic)\ reply\_count\_automatic_integer_\ \ The total number of automatic replies detected\ \ Example: 15\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=reply_count_automatic_unique)\ reply\_count\_automatic\_unique_integer_\ \ The number of unique automatic replies (first automatic reply per lead)\ \ Example: 12\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=reply_count_automatic_unique_by_step)\ reply\_count\_automatic\_unique\_by\_step_integer_\ \ The number of unique automatic replies per step\ \ Example: 18\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=link_click_count_unique)\ link\_click\_count\_unique_integer_\ \ The number of unique link clicks (first click per lead)\ \ Example: 600\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=link_click_count_unique_by_step)\ link\_click\_count\_unique\_by\_step_integer_\ \ The number of unique link clicks per step (first click per lead per step)\ \ Example: 720\ \ \] Response 1. 200 2. 400 3. 401 4. 404 5. 429 application/json \[\ {\ "campaign\_name": "My Test Campaign",\ "campaign\_id": "019c9b71-ee3b-70c6-8e78-b4ac05ee54ba",\ "campaign\_status": 1,\ "campaign\_is\_evergreen": true,\ "leads\_count": 1500,\ "contacted\_count": 1200,\ "emails\_sent\_count": 5000,\ "new\_leads\_contacted\_count": 200,\ "open\_count": 800,\ "open\_count\_unique": 750,\ "open\_count\_unique\_by\_step": 900,\ "reply\_count": 300,\ "reply\_count\_unique": 280,\ "reply\_count\_unique\_by\_step": 350,\ "reply\_count\_automatic": 15,\ "reply\_count\_automatic\_unique": 12,\ "reply\_count\_automatic\_unique\_by\_step": 18,\ "link\_click\_count": 800,\ "link\_click\_count\_unique": 600,\ "link\_click\_count\_unique\_by\_step": 720,\ "bounced\_count": 50,\ "unsubscribed\_count": 20,\ "completed\_count": 1100,\ "total\_opportunities": 10,\ "total\_opportunity\_value": 1000\ }\ \] #### Was this helpful? [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview) Get campaign(s) analytics overview ------------------------------------------------------------------------------------------------------------------- #### [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/request) Request 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. Security: ApiKeyAuth [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/request/query) Query [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=request&in=query&path=id) id_string__(uuid)_ A campaign ID to get the analytics overview for. Leave this field empty to get the analytics overview for all campaigns Example: id=019c9b71-ee3b-70c6-8e78-b4ad08832181 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=request&in=query&path=ids) ids_Array of strings__(uuid)_ Example: ids=019c9b71-ee3c-7ffc-873f-f9193acd9a12 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=request&in=query&path=start_date) start\_date_string_ Start date Example: start\_date=2024-01-01 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=request&in=query&path=end_date) end\_date_string_ End date Example: end\_date=2024-01-01 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=request&in=query&path=campaign_status) campaign\_status_number_ 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 | Example: campaign\_status=1 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=request&in=query&path=expand_crm_events) expand\_crm\_events_boolean_ 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). Default false Example: expand\_crm\_events=true get /api/v2/campaigns/analytics/overview * Instantly API Server https://api.instantly.ai/api/v2/campaigns/analytics/overview * Mock server https://developer.instantly.ai/\_mock/api/v2/api/v2/campaigns/analytics/overview curl * curl * JavaScript * Node.js * Python * Java * C# * PHP * Go * Ruby * R * Payload 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=019c9b71-ee3b-70c6-8e78-b4ad08832181&ids=019c9b71-ee3c-7ffc-873f-f9193acd9a12&start\_date=2024-01-01' \\ -H 'Authorization: Bearer ' Try it #### [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/response&c=200) Responses 1. 200 2. 400 3. 401 4. 404 5. 429 Default Response [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/response&c=200/body) Bodyapplication/json [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=open_count) open\_count_integer_ The total number of times the emails were opened, including duplicates Example: 800 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=open_count_unique) open\_count\_unique_integer_ The number of emails that got opened (for the first time only) Example: 800 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=open_count_unique_by_step) open\_count\_unique\_by\_step_integer_ The unique number of times the emails were opened (counted once per lead, step, and campaign) Example: 800 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=link_click_count) link\_click\_count_integer_ The number of links that got clicked Example: 800 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=link_click_count_unique) link\_click\_count\_unique_integer_ The number of links that got clicked (for the first time) Example: 800 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=link_click_count_unique_by_step) link\_click\_count\_unique\_by\_step_integer_ The unique number of links that got clicked, per step (counted once per lead, step, and campaign) Example: 800 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=reply_count) reply\_count_integer_ The total number of replies received (if a lead replies multiple times, each reply is counted) Example: 300 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=reply_count_unique) reply\_count\_unique_integer_ The number of unique replies (first reply per lead). Excludes automatic replies. Example: 300 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=reply_count_unique_by_step) reply\_count\_unique\_by\_step_integer_ The number of unique replies per step (first reply per lead per step). Excludes automatic replies. Example: 300 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=reply_count_automatic) reply\_count\_automatic_integer_ The total number of automatic replies received (e.g., out-of-office) Example: 50 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=reply_count_automatic_unique) reply\_count\_automatic\_unique_integer_ The number of unique leads that sent automatic replies Example: 45 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=reply_count_automatic_unique_by_step) reply\_count\_automatic\_unique\_by\_step_integer_ The unique number of automatic replies per step (counted once per lead, step, and campaign) Example: 45 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=bounced_count) bounced\_count_integer_ The number of bounced leads Example: 50 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=unsubscribed_count) unsubscribed\_count_integer_ The number of unsubscribed leads Example: 20 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=completed_count) completed\_count_integer_ The number of leads that the campaign was completed for Example: 1100 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=emails_sent_count) emails\_sent\_count_integer_ The total number of sent emails Example: 5000 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=contacted_count) contacted\_count_integer_ The total number of unique leads contacted Example: 4500 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=new_leads_contacted_count) new\_leads\_contacted\_count_integer_ The total number of new leads contacted Example: 200 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=total_opportunities) total\_opportunities_integer_ The total number of unique opportunities created Example: 10 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=total_opportunity_value) total\_opportunity\_value_number_ The total value of opportunities created Example: 1000 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=total_interested) total\_interested_integer_ The total number of interested opportunities created Example: 103 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=total_meeting_booked) total\_meeting\_booked_integer_ The total number of meeting booked opportunities created Example: 45 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=total_meeting_completed) total\_meeting\_completed_integer_ The total number of meeting completed opportunities created Example: 12 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=total_closed) total\_closed_integer_ The total number of closed opportunities created Example: 10 Response 1. 200 2. 400 3. 401 4. 404 5. 429 application/json { "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, "reply\_count\_automatic": 50, "reply\_count\_automatic\_unique": 45, "reply\_count\_automatic\_unique\_by\_step": 45, "bounced\_count": 50, "unsubscribed\_count": 20, "completed\_count": 1100, "emails\_sent\_count": 5000, "contacted\_count": 4500, "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 } #### Was this helpful? [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics) Get daily campaign analytics ---------------------------------------------------------------------------------------------------------- #### [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/request) Request Get campaign daily analytics Security: ApiKeyAuth [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/request/query) Query [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=request&in=query&path=campaign_id) campaign\_id_string__(uuid)_ Campaign ID (optional). Leave this field empty to get the analytics for all campaigns Example: campaign\_id=019c9b71-ee3c-7ffc-873f-f91a3db506d7 [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=request&in=query&path=start_date) start\_date_string_ Start date Example: start\_date=2024-01-01 [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=request&in=query&path=end_date) end\_date_string_ End date Example: end\_date=2024-01-01 [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=request&in=query&path=campaign_status) campaign\_status_number_ 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 | Example: campaign\_status=1 get /api/v2/campaigns/analytics/daily * Instantly API Server https://api.instantly.ai/api/v2/campaigns/analytics/daily * Mock server https://developer.instantly.ai/\_mock/api/v2/api/v2/campaigns/analytics/daily curl * curl * JavaScript * Node.js * Python * Java * C# * PHP * Go * Ruby * R * Payload curl -i -X GET \\ 'https://api.instantly.ai/api/v2/campaigns/analytics/daily?campaign\_id=019c9b71-ee3c-7ffc-873f-f91a3db506d7&campaign\_status=1&end\_date=2024-01-01&start\_date=2024-01-01' \\ -H 'Authorization: Bearer ' Try it #### [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/response&c=200) Responses 1. 200 2. 400 3. 401 4. 404 5. 429 Default Response [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/response&c=200/body) Bodyapplication/jsonArray \[\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=response&c=200&path=date)\ date_string_\ \ The date of the analytics entry, in YYYY-MM-DD format\ \ Example: "2025-03-01"\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=response&c=200&path=sent)\ sent_integer_\ \ The total number of sent emails\ \ Example: 5421\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=response&c=200&path=contacted)\ contacted_integer_\ \ The total number of unique contacts who received an email that day\ \ Example: 5000\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=response&c=200&path=new_leads_contacted)\ new\_leads\_contacted_integer_\ \ The total number of new leads contacted that day\ \ Example: 200\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=response&c=200&path=opened)\ opened_integer_\ \ The total number of opened emails\ \ Example: 99\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=response&c=200&path=unique_opened)\ unique\_opened_integer_\ \ The total number of unique opened emails\ \ Example: 60\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=response&c=200&path=replies)\ replies_integer_\ \ The total number of replies\ \ Example: 60\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=response&c=200&path=unique_replies)\ unique\_replies_integer_\ \ The total number of unique replies\ \ Example: 60\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=response&c=200&path=replies_automatic)\ replies\_automatic_integer_\ \ The total number of automatic replies detected\ \ Example: 5\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=response&c=200&path=unique_replies_automatic)\ unique\_replies\_automatic_integer_\ \ The total number of unique automatic replies detected\ \ Example: 4\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=response&c=200&path=clicks)\ clicks_integer_\ \ The total number of links clicked\ \ Example: 60\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=response&c=200&path=unique_clicks)\ unique\_clicks_integer_\ \ The total number of unique links clicked. Unique meaning from unique leads, not unique links. For instance, if a lead clicked a link 3 times, it will be counted as 1 unique click. If a lead clicked 3 different links, it will still be counted as 1 unique click\ \ Example: 60\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=response&c=200&path=opportunities)\ opportunities_integer_\ \ The total number of unique opportunities created from the campaign on that day\ \ Example: 5\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=response&c=200&path=unique_opportunities)\ unique\_opportunities_integer_\ \ The total number of unique opportunities created from unique leads from the campaign on that day\ \ Example: 3\ \ \] Response 1. 200 2. 400 3. 401 4. 404 5. 429 application/json \[\ {\ "date": "2025-03-01",\ "sent": 5421,\ "contacted": 5000,\ "new\_leads\_contacted": 200,\ "opened": 99,\ "unique\_opened": 60,\ "replies": 60,\ "unique\_replies": 60,\ "replies\_automatic": 5,\ "unique\_replies\_automatic": 4,\ "clicks": 60,\ "unique\_clicks": 60,\ "opportunities": 5,\ "unique\_opportunities": 3\ }\ \] #### Was this helpful? [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics) Get campaign steps analytics ---------------------------------------------------------------------------------------------------------- #### [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/request) Request Get campaign steps analytics Security: ApiKeyAuth [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/request/query) Query [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=request&in=query&path=campaign_id) campaign\_id_string__(uuid)_ Campaign ID (optional). Leave this field empty to get the analytics for all campaigns Example: campaign\_id=019c9b71-ee3d-7db5-8ef1-69bed0cb34fc [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=request&in=query&path=start_date) start\_date_string_ Start date Example: start\_date=2024-01-01 [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=request&in=query&path=end_date) end\_date_string_ End date Example: end\_date=2024-01-01 [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=request&in=query&path=include_opportunities_count) include\_opportunities\_count_boolean_ Whether to include the opportunities count per step. If this field is true then `opportunities` and `unique_opportunities` fields will be included in the response Default false Example: include\_opportunities\_count=true get /api/v2/campaigns/analytics/steps * Instantly API Server https://api.instantly.ai/api/v2/campaigns/analytics/steps * Mock server https://developer.instantly.ai/\_mock/api/v2/api/v2/campaigns/analytics/steps curl * curl * JavaScript * Node.js * Python * Java * C# * PHP * Go * Ruby * R * Payload curl -i -X GET \\ 'https://api.instantly.ai/api/v2/campaigns/analytics/steps?campaign\_id=019c9b71-ee3d-7db5-8ef1-69bed0cb34fc&end\_date=2024-01-01&include\_opportunities\_count=true&start\_date=2024-01-01' \\ -H 'Authorization: Bearer ' Try it #### [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/response&c=200) Responses 1. 200 2. 400 3. 401 4. 404 5. 429 Default Response [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/response&c=200/body) Bodyapplication/jsonArray \[\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=response&c=200&path=step)\ step_null or string_required\ \ The step number. When null it means we couldn't determine the step number for the event, for instance for list leads, which are not part of a campaign.\ \ Example: "1"\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=response&c=200&path=variant)\ variant_null or string_required\ \ The variant number, starting from 0. 0 = A, 1 = B, 2 = C, etc. When null it means we couldn't determine the variant for the event.\ \ Example: "0"\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=response&c=200&path=sent)\ sent_integer_required\ \ The total number of sent emails\ \ Example: 5421\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=response&c=200&path=opened)\ opened_integer_required\ \ The total number of opened emails\ \ Example: 99\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=response&c=200&path=unique_opened)\ unique\_opened_integer_required\ \ The total number of opened emails\ \ Example: 60\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=response&c=200&path=replies)\ replies_integer_required\ \ The total number of replies\ \ Example: 60\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=response&c=200&path=unique_replies)\ unique\_replies_integer_required\ \ The total number of replies\ \ Example: 60\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=response&c=200&path=replies_automatic)\ replies\_automatic_integer_required\ \ The total number of automatic replies detected\ \ Example: 5\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=response&c=200&path=unique_replies_automatic)\ unique\_replies\_automatic_integer_required\ \ The total number of unique automatic replies detected\ \ Example: 4\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=response&c=200&path=clicks)\ clicks_integer_required\ \ The total number of links clicked\ \ Example: 60\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=response&c=200&path=unique_clicks)\ unique\_clicks_integer_required\ \ The total number of unique links clicked. Unique meaning from unique leads, not unique links. For instance, if a lead clicked a link 3 times, it will be counted as 1 unique click. If a lead clicked 3 different links, it will still be counted as 1 unique click\ \ Example: 60\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=response&c=200&path=opportunities)\ opportunities_integer_\ \ The total number of opportunities created from this step. Included only if `include_opportunities_count` is `true`\ \ Example: 10\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=response&c=200&path=unique_opportunities)\ unique\_opportunities_integer_\ \ The total number of unique opportunities created from this step. Unique meaning unique per lead. If a lead has multiple opportunities, it will be counted as 1 unique opportunity. Included only if `include_opportunities_count` is `true`\ \ Example: 8\ \ \] Response 1. 200 2. 400 3. 401 4. 404 5. 429 application/json \[\ {\ "step": "1",\ "variant": "0",\ "sent": 5421,\ "opened": 99,\ "unique\_opened": 60,\ "replies": 60,\ "unique\_replies": 60,\ "replies\_automatic": 5,\ "unique\_replies\_automatic": 4,\ "clicks": 60,\ "unique\_clicks": 60,\ "opportunities": 10,\ "unique\_opportunities": 8\ }\ \] #### Was this helpful? [](https://developer.instantly.ai/api/v2/oauth) OAuth ----------------------------------------------------- OAuth authentication endpoints for connecting Google and Microsoft email accounts Operations post /api/v2/oauth/google/init post /api/v2/oauth/microsoft/init get /api/v2/oauth/session/status/{sessionId} \+ Show [](https://developer.instantly.ai/api/v2/account) Account --------------------------------------------------------- An email account that can be used to send campaigns Operations post /api/v2/accounts get /api/v2/accounts get /api/v2/accounts/{email} patch /api/v2/accounts/{email} delete /api/v2/accounts/{email} post /api/v2/accounts/warmup/enable post /api/v2/accounts/warmup/disable post /api/v2/accounts/warmup-analyticsShow 7 more... \+ Show [](https://developer.instantly.ai/api/v2/campaign) Campaign ----------------------------------------------------------- A campaign that can be sent to a list of recipients Operations post /api/v2/campaigns get /api/v2/campaigns post /api/v2/campaigns/{id}/activate post /api/v2/campaigns/{id}/pause get /api/v2/campaigns/{id} patch /api/v2/campaigns/{id} delete /api/v2/campaigns/{id} get /api/v2/campaigns/search-by-contactShow 11 more... \+ Show [](https://developer.instantly.ai/api/v2/email) Email ----------------------------------------------------- A campaign email, a reply, a manually sent email, or any other email that's visible in the Unibox Operations post /api/v2/emails/reply post /api/v2/emails/forward get /api/v2/emails get /api/v2/emails/{id} patch /api/v2/emails/{id} delete /api/v2/emails/{id} get /api/v2/emails/unread/count post /api/v2/emails/threads/{thread\_id}/mark-as-read \+ Show [](https://developer.instantly.ai/api/v2/emailverification) Email Verification ------------------------------------------------------------------------------ A single email verification Operations post /api/v2/email-verification get /api/v2/email-verification/{email} \+ Show [](https://developer.instantly.ai/api/v2/leadlist) Lead List ------------------------------------------------------------ A list used to store leads Operations post /api/v2/lead-lists get /api/v2/lead-lists get /api/v2/lead-lists/{id} patch /api/v2/lead-lists/{id} delete /api/v2/lead-lists/{id} get /api/v2/lead-lists/{id}/verification-stats \+ Show [](https://developer.instantly.ai/api/v2/inboxplacementtest) Inbox Placement Test --------------------------------------------------------------------------------- An inbox placement test Operations post /api/v2/inbox-placement-tests get /api/v2/inbox-placement-tests get /api/v2/inbox-placement-tests/{id} delete /api/v2/inbox-placement-tests/{id} patch /api/v2/inbox-placement-tests/{id} get /api/v2/inbox-placement-tests/email-service-provider-options \+ Show [](https://developer.instantly.ai/api/v2/inboxplacementanalytics) Inbox Placement Analytics ------------------------------------------------------------------------------------------- Analytics data for individual emails in inbox placement tests Operations get /api/v2/inbox-placement-analytics get /api/v2/inbox-placement-analytics/{id} post /api/v2/inbox-placement-analytics/stats-by-test-id post /api/v2/inbox-placement-analytics/deliverability-insights post /api/v2/inbox-placement-analytics/stats-by-date \+ Show [](https://developer.instantly.ai/api/v2/inboxplacementblacklistandspamassassinreport) Inbox Placement Blacklist & SpamAssassin Report -------------------------------------------------------------------------------------------------------------------------------------- Report data for an inbox placement test Operations get /api/v2/inbox-placement-reports get /api/v2/inbox-placement-reports/{id} \+ Show [](https://developer.instantly.ai/api/v2/apikey) API Key -------------------------------------------------------- API Key Operations post /api/v2/api-keys get /api/v2/api-keys delete /api/v2/api-keys/{id} \+ Show [](https://developer.instantly.ai/api/v2/accountcampaignmapping) Account Campaign Mapping ----------------------------------------------------------------------------------------- Account Campaign Mapping Operations get /api/v2/account-campaign-mappings/{email} \+ Show [](https://developer.instantly.ai/api/v2/lead) Lead --------------------------------------------------- A lead entity representing an individual lead Operations post /api/v2/leads delete /api/v2/leads post /api/v2/leads/list get /api/v2/leads/{id} patch /api/v2/leads/{id} delete /api/v2/leads/{id} post /api/v2/leads/merge post /api/v2/leads/update-interest-statusShow 5 more... \+ Show [](https://developer.instantly.ai/api/v2/backgroundjob) Background Job ---------------------------------------------------------------------- A background job that can be used to perform long-running tasks Operations get /api/v2/background-jobs get /api/v2/background-jobs/{id} \+ Show [](https://developer.instantly.ai/api/v2/customtag) Custom Tag -------------------------------------------------------------- A custom tag for organizing and categorizing accounts and campaigns. You can use them as filters in apis that list accounts and campaigns. Operations post /api/v2/custom-tags get /api/v2/custom-tags get /api/v2/custom-tags/{id} patch /api/v2/custom-tags/{id} delete /api/v2/custom-tags/{id} post /api/v2/custom-tags/toggle-resource \+ Show [](https://developer.instantly.ai/api/v2/customtagmapping) Custom Tag Mapping ----------------------------------------------------------------------------- This entity represents a tag being assigned to a specific campaign or email account. When an email account is assigned a tag, a new custom tag mapping entry is created, which connects the tag (`tag_id` field) with the email account (`resource_id` field). You can use it to see which tag si connected to which resource. Operations get /api/v2/custom-tag-mappings \+ Show [](https://developer.instantly.ai/api/v2/blocklistentry) Block List Entry ------------------------------------------------------------------------- A blocked email or domain Operations post /api/v2/block-lists-entries get /api/v2/block-lists-entries get /api/v2/block-lists-entries/{id} patch /api/v2/block-lists-entries/{id} delete /api/v2/block-lists-entries/{id} \+ Show [](https://developer.instantly.ai/api/v2/leadlabel) Lead Label -------------------------------------------------------------- A custom label for categorizing and managing leads Operations post /api/v2/lead-labels get /api/v2/lead-labels get /api/v2/lead-labels/{id} patch /api/v2/lead-labels/{id} delete /api/v2/lead-labels/{id} post /api/v2/lead-labels/ai-reply-label \+ Show [](https://developer.instantly.ai/api/v2/workspace) Workspace ------------------------------------------------------------- A workspace entity representing a workspace Operations get /api/v2/workspaces/current patch /api/v2/workspaces/current post /api/v2/workspaces/current/whitelabel-domain get /api/v2/workspaces/current/whitelabel-domain delete /api/v2/workspaces/current/whitelabel-domain post /api/v2/workspaces/current/change-owner \+ Show [](https://developer.instantly.ai/api/v2/supersearchenrichment) SuperSearch Enrichment -------------------------------------------------------------------------------------- An enrichment can take different forms, such as email enrichment or LinkedIn enrichment. Leads may be imported from SuperSearch using the dedicated endpoint, or enriched directly within a list or campaign by attaching an enrichment to it. Operations post /api/v2/supersearch-enrichment/enrich-leads-from-supersearch get /api/v2/supersearch-enrichment/{resource\_id} post /api/v2/supersearch-enrichment patch /api/v2/supersearch-enrichment/{resource\_id}/settings post /api/v2/supersearch-enrichment/ai get /api/v2/supersearch-enrichment/ai/{resource\_id}/in-progress get /api/v2/supersearch-enrichment/history/{resource\_id} post /api/v2/supersearch-enrichment/runShow 2 more... \+ Show [](https://developer.instantly.ai/api/v2/workspacegroupmember) 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 post /api/v2/workspace-group-members get /api/v2/workspace-group-members get /api/v2/workspace-group-members/{id} delete /api/v2/workspace-group-members/{id} get /api/v2/workspace-group-members/admin \+ Show [](https://developer.instantly.ai/api/v2/workspacemember) Workspace Member -------------------------------------------------------------------------- A member of a workspace with associated user details Operations post /api/v2/workspace-members get /api/v2/workspace-members get /api/v2/workspace-members/{id} patch /api/v2/workspace-members/{id} delete /api/v2/workspace-members/{id} \+ Show [](https://developer.instantly.ai/api/v2/campaignsubsequence) Campaign Subsequence ---------------------------------------------------------------------------------- A subsequence entity representing a follow-up sequence Operations post /api/v2/subsequences get /api/v2/subsequences post /api/v2/subsequences/{id}/duplicate post /api/v2/subsequences/{id}/pause post /api/v2/subsequences/{id}/resume get /api/v2/subsequences/{id} patch /api/v2/subsequences/{id} delete /api/v2/subsequences/{id}Show 1 more... \+ Show [](https://developer.instantly.ai/api/v2/auditlog) Audit Log ------------------------------------------------------------ Audit log records for tracking system activities Operations get /api/v2/audit-logs \+ Show [](https://developer.instantly.ai/api/v2/webhook) Webhook --------------------------------------------------------- A webhook subscription for receiving event notifications Operations get /api/v2/webhooks post /api/v2/webhooks get /api/v2/webhooks/{id} patch /api/v2/webhooks/{id} delete /api/v2/webhooks/{id} get /api/v2/webhooks/event-types post /api/v2/webhooks/{id}/test post /api/v2/webhooks/{id}/resume \+ Show [](https://developer.instantly.ai/api/v2/webhookevent) Webhook Event -------------------------------------------------------------------- A webhook event that was sent or attempted to be sent Operations get /api/v2/webhook-events get /api/v2/webhook-events/{id} get /api/v2/webhook-events/summary get /api/v2/webhook-events/summary-by-date \+ Show [](https://developer.instantly.ai/api/v2/dfyemailaccountorder) DFY Email Account Order -------------------------------------------------------------------------------------- A Done-For-You email account order Operations post /api/v2/dfy-email-account-orders get /api/v2/dfy-email-account-orders post /api/v2/dfy-email-account-orders/domains/similar post /api/v2/dfy-email-account-orders/domains/check post /api/v2/dfy-email-account-orders/domains/pre-warmed-up-list get /api/v2/dfy-email-account-orders/accounts post /api/v2/dfy-email-account-orders/accounts/cancel \+ Show [](https://developer.instantly.ai/api/v2/customprompttemplate) Custom Prompt Template ------------------------------------------------------------------------------------- Custom prompt templates for creating custom prompts \+ Show [](https://developer.instantly.ai/api/v2/salesflow) Sales Flow -------------------------------------------------------------- Manages how sales users view and interact with campaign and lead lists within the sales flow. \+ Show [](https://developer.instantly.ai/api/v2/emailtemplate) Email Template ---------------------------------------------------------------------- A campaign email template \+ Show [](https://developer.instantly.ai/api/v2/workspacebilling) Workspace Billing ---------------------------------------------------------------------------- Workspace Billing Operations get /api/v2/workspace-billing/plan-details get /api/v2/workspace-billing/subscription-details \+ Show [](https://developer.instantly.ai/api/v2/crmactions) CRM Actions ---------------------------------------------------------------- CRM related actions Operations get /api/v2/crm-actions/phone-numbers delete /api/v2/crm-actions/phone-numbers/{id} \+ Show [](https://developer.instantly.ai/api/v2/schemas) Schemas --------------------------------------------------------- \+ Show --- # Get warmup analytics [Analytics](https://developer.instantly.ai/api/v2/analytics) / Get warmup 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/ [](https://developer.instantly.ai/api/v2/analytics) Analytics ------------------------------------------------------------- Endpoints related to analytics Operations post /api/v2/accounts/warmup-analytics get /api/v2/accounts/analytics/daily post /api/v2/accounts/test/vitals get /api/v2/campaigns/analytics get /api/v2/campaigns/analytics/overview get /api/v2/campaigns/analytics/daily get /api/v2/campaigns/analytics/steps [](https://developer.instantly.ai/api/v2/analytics/getwarmupanalytics) Get warmup analytics ------------------------------------------------------------------------------------------- #### [](https://developer.instantly.ai/api/v2/analytics/getwarmupanalytics#analytics/getwarmupanalytics/request) Request Requires one of the following scopes: `accounts:read`, `accounts:all`, `all:read`, `all:all` Security: ApiKeyAuth [](https://developer.instantly.ai/api/v2/analytics/getwarmupanalytics#analytics/getwarmupanalytics/request/body) Bodyapplication/jsonrequired [](https://developer.instantly.ai/api/v2/analytics/getwarmupanalytics#analytics/getwarmupanalytics/t=request&path=emails) emails_Array of strings__\[ 1 .. 100 \] items_required List of emails to get warmup analytics for. The emails should be attached to accounts in your workspace. Example: \["user@example.com"\] post /api/v2/accounts/warmup-analytics * Instantly API Server https://api.instantly.ai/api/v2/accounts/warmup-analytics * Mock server https://developer.instantly.ai/\_mock/api/v2/api/v2/accounts/warmup-analytics curl * curl * JavaScript * Node.js * Python * Java * C# * PHP * Go * Ruby * R * Payload curl -i -X POST \\ https://api.instantly.ai/api/v2/accounts/warmup-analytics \\ -H 'Authorization: Bearer ' \\ -H 'Content-Type: application/json' \\ -d '{ "emails": \[\ "user@example.com"\ \] }' Try it #### [](https://developer.instantly.ai/api/v2/analytics/getwarmupanalytics#analytics/getwarmupanalytics/response&c=200) Responses 1. 200 2. 401 3. 429 Expand all Default Response [](https://developer.instantly.ai/api/v2/analytics/getwarmupanalytics#analytics/getwarmupanalytics/response&c=200/body) Bodyapplication/json [](https://developer.instantly.ai/api/v2/analytics/getwarmupanalytics#analytics/getwarmupanalytics/t=response&c=200&path=email_date_data) email\_date\_data_object_ 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}}} +Show property [](https://developer.instantly.ai/api/v2/analytics/getwarmupanalytics#analytics/getwarmupanalytics/t=response&c=200&path=aggregate_data) aggregate\_data_object_ 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}} +Show property Response 1. 200 2. 401 3. 429 application/json { "email\_date\_data": { "example1@example.com": { … }, "example2@example.com": { … } }, "aggregate\_data": { "example1@example.com": { … }, "example2@example.com": { … } } } #### Was this helpful? [](https://developer.instantly.ai/api/v2/analytics/getdailyaccountanalytics) Get daily account analytics -------------------------------------------------------------------------------------------------------- #### [](https://developer.instantly.ai/api/v2/analytics/getdailyaccountanalytics#analytics/getdailyaccountanalytics/request) Request Get daily account analytics showing the number of emails sent per day for each email account. Useful for tracking daily sending activity across your accounts. Security: ApiKeyAuth [](https://developer.instantly.ai/api/v2/analytics/getdailyaccountanalytics#analytics/getdailyaccountanalytics/request/query) Query [](https://developer.instantly.ai/api/v2/analytics/getdailyaccountanalytics#analytics/getdailyaccountanalytics/t=request&in=query&path=start_date) start\_date_string_ Start date for the analytics period (optional). If not provided, returns data for the last 30 days. Example: start\_date=2024-01-01 [](https://developer.instantly.ai/api/v2/analytics/getdailyaccountanalytics#analytics/getdailyaccountanalytics/t=request&in=query&path=end_date) end\_date_string_ End date for the analytics period (optional). If not provided, defaults to current date. Example: end\_date=2024-01-31 [](https://developer.instantly.ai/api/v2/analytics/getdailyaccountanalytics#analytics/getdailyaccountanalytics/t=request&in=query&path=emails) emails_Array of strings_ Filter by specific email accounts (optional). If not provided, returns data for all accounts in your workspace. Example: emails=user@example.com get /api/v2/accounts/analytics/daily * Instantly API Server https://api.instantly.ai/api/v2/accounts/analytics/daily * Mock server https://developer.instantly.ai/\_mock/api/v2/api/v2/accounts/analytics/daily curl * curl * JavaScript * Node.js * Python * Java * C# * PHP * Go * Ruby * R * Payload curl -i -X GET \\ 'https://api.instantly.ai/api/v2/accounts/analytics/daily?emails=user%40example.com&end\_date=2024-01-31&start\_date=2024-01-01' \\ -H 'Authorization: Bearer ' Try it #### [](https://developer.instantly.ai/api/v2/analytics/getdailyaccountanalytics#analytics/getdailyaccountanalytics/response&c=200) Responses 1. 200 2. 400 3. 401 4. 429 Default Response [](https://developer.instantly.ai/api/v2/analytics/getdailyaccountanalytics#analytics/getdailyaccountanalytics/response&c=200/body) Bodyapplication/jsonArray \[\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailyaccountanalytics#analytics/getdailyaccountanalytics/t=response&c=200&path=date)\ date_string_required\ \ The date of the analytics entry, in YYYY-MM-DD format\ \ Example: "2024-01-15"\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailyaccountanalytics#analytics/getdailyaccountanalytics/t=response&c=200&path=email_account)\ email\_account_string_required\ \ The email account that sent the emails\ \ Example: "user@example.com"\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailyaccountanalytics#analytics/getdailyaccountanalytics/t=response&c=200&path=sent)\ sent_integer_required\ \ The total number of campaign emails sent on this date by this account, including emails for subsequences\ \ Example: 150\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailyaccountanalytics#analytics/getdailyaccountanalytics/t=response&c=200&path=bounced)\ bounced_integer_required\ \ The number of emails that bounced on this date for this account for campaigns - including subsequences\ \ Example: 3\ \ \] Response 1. 200 2. 400 3. 401 4. 429 application/json \[\ {\ "date": "2024-01-15",\ "email\_account": "user@example.com",\ "sent": 150,\ "bounced": 3\ }\ \] #### Was this helpful? [](https://developer.instantly.ai/api/v2/analytics/testaccountvitals) Test account vitals ----------------------------------------------------------------------------------------- #### [](https://developer.instantly.ai/api/v2/analytics/testaccountvitals#analytics/testaccountvitals/request) Request Requires one of the following scopes: `accounts:read`, `accounts:all`, `all:read`, `all:all` Security: ApiKeyAuth [](https://developer.instantly.ai/api/v2/analytics/testaccountvitals#analytics/testaccountvitals/request/body) Bodyapplication/json [](https://developer.instantly.ai/api/v2/analytics/testaccountvitals#analytics/testaccountvitals/t=request&path=accounts) accounts_Array of strings_ Example: \["user@example.com"\] post /api/v2/accounts/test/vitals * Instantly API Server https://api.instantly.ai/api/v2/accounts/test/vitals * Mock server https://developer.instantly.ai/\_mock/api/v2/api/v2/accounts/test/vitals curl * curl * JavaScript * Node.js * Python * Java * C# * PHP * Go * Ruby * R * Payload curl -i -X POST \\ https://api.instantly.ai/api/v2/accounts/test/vitals \\ -H 'Authorization: Bearer ' \\ -H 'Content-Type: application/json' \\ -d '{}' Try it #### [](https://developer.instantly.ai/api/v2/analytics/testaccountvitals#analytics/testaccountvitals/response&c=200) Responses 1. 200 2. 400 3. 401 4. 429 Expand all Default Response [](https://developer.instantly.ai/api/v2/analytics/testaccountvitals#analytics/testaccountvitals/response&c=200/body) Bodyapplication/json [](https://developer.instantly.ai/api/v2/analytics/testaccountvitals#analytics/testaccountvitals/t=response&c=200&path=status) status_string_ Example: "success" [](https://developer.instantly.ai/api/v2/analytics/testaccountvitals#analytics/testaccountvitals/t=response&c=200&path=success_list) success\_list_Array of objects_ +Show 6 array properties [](https://developer.instantly.ai/api/v2/analytics/testaccountvitals#analytics/testaccountvitals/t=response&c=200&path=failure_list) failure\_list_Array of objects_ +Show 6 array properties Response 1. 200 2. 400 3. 401 4. 429 application/json { "status": "success", "success\_list": \[\ { … }\ \], "failure\_list": \[\ { … }\ \] } #### Was this helpful? [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics) Get campaign(s) analytics -------------------------------------------------------------------------------------------------- #### [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/request) 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 Security: ApiKeyAuth [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/request/query) Query [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=request&in=query&path=id) id_string__(uuid)_ A campaign ID to get the analytics for. Leave this field empty to get the analytics for all campaigns Example: id=019c9b71-ee3b-70c6-8e78-b4aa88251a46 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=request&in=query&path=ids) ids_Array of strings__(uuid)_ Example: ids=019c9b71-ee3b-70c6-8e78-b4abfdb12c1c [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=request&in=query&path=start_date) start\_date_string_ Start date Example: start\_date=2024-01-01 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=request&in=query&path=end_date) end\_date_string_ End date Example: end\_date=2024-01-01 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=request&in=query&path=exclude_total_leads_count) exclude\_total\_leads\_count_boolean_ Exclude the total leads from the result. Setting this to true will considerably decrease the response time Default false Example: exclude\_total\_leads\_count=true get /api/v2/campaigns/analytics * Instantly API Server https://api.instantly.ai/api/v2/campaigns/analytics * Mock server https://developer.instantly.ai/\_mock/api/v2/api/v2/campaigns/analytics curl * curl * JavaScript * Node.js * Python * Java * C# * PHP * Go * Ruby * R * Payload curl -i -X GET \\ 'https://api.instantly.ai/api/v2/campaigns/analytics?end\_date=2024-01-01&exclude\_total\_leads\_count=true&id=019c9b71-ee3b-70c6-8e78-b4aa88251a46&ids=019c9b71-ee3b-70c6-8e78-b4abfdb12c1c&start\_date=2024-01-01' \\ -H 'Authorization: Bearer ' Try it #### [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/response&c=200) Responses 1. 200 2. 400 3. 401 4. 404 5. 429 Default Response [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/response&c=200/body) Bodyapplication/jsonArray \[\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=campaign_name)\ campaign\_name_string_required\ \ The name of the campaign\ \ Example: "My Test Campaign"\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=campaign_id)\ campaign\_id_string__(uuid)_required\ \ The ID of the campaign\ \ Example: "019c9b71-ee3b-70c6-8e78-b4ac05ee54ba"\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=campaign_status)\ campaign\_status_number_required\ \ The campaign status\ \ | Enum Value | Description |\ | --- | --- |\ | 0 | Draft |\ | 1 | Active |\ | 2 | Paused |\ | 3 | Completed |\ | 4 | Running Subsequences |\ | \-99 | Account Suspended |\ | \-1 | Accounts Unhealthy |\ | \-2 | Bounce Protect |\ \ Example: 1\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=campaign_is_evergreen)\ campaign\_is\_evergreen_boolean_required\ \ Whether the campaign is evergreen\ \ Example: true\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=leads_count)\ leads\_count_integer_required\ \ The total number of leads\ \ Example: 1500\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=contacted_count)\ contacted\_count_integer_required\ \ Number of leads for whom the sequence has started\ \ Example: 1200\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=open_count)\ open\_count_integer_required\ \ The number of leads that opened at least one email\ \ Example: 800\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=reply_count)\ reply\_count_integer_required\ \ The total number of replies received (if a lead replies multiple times, each reply is counted)\ \ Example: 300\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=link_click_count)\ link\_click\_count_integer_required\ \ The number of links that got clicked\ \ Example: 800\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=bounced_count)\ bounced\_count_integer_required\ \ The number of bounced leads\ \ Example: 50\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=unsubscribed_count)\ unsubscribed\_count_integer_required\ \ The number of unsubscribed leads\ \ Example: 20\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=completed_count)\ completed\_count_integer_required\ \ The number of leads that the campaign was completed for\ \ Example: 1100\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=emails_sent_count)\ emails\_sent\_count_integer_required\ \ The total number of sent emails\ \ Example: 5000\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=new_leads_contacted_count)\ new\_leads\_contacted\_count_integer_required\ \ The total number of new leads contacted\ \ Example: 200\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=total_opportunities)\ total\_opportunities_integer_required\ \ The total number of unique opportunities created\ \ Example: 10\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=total_opportunity_value)\ total\_opportunity\_value_number_required\ \ The total value of opportunities created\ \ Example: 1000\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=open_count_unique)\ open\_count\_unique_integer_\ \ The number of unique email opens (first open per lead)\ \ Example: 750\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=open_count_unique_by_step)\ open\_count\_unique\_by\_step_integer_\ \ The number of unique email opens per step (first open per lead per step)\ \ Example: 900\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=reply_count_unique)\ reply\_count\_unique_integer_\ \ The number of unique replies (first reply per lead). Excludes automatic replies.\ \ Example: 280\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=reply_count_unique_by_step)\ reply\_count\_unique\_by\_step_integer_\ \ The number of unique replies per step (first reply per lead per step). Excludes automatic replies.\ \ Example: 350\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=reply_count_automatic)\ reply\_count\_automatic_integer_\ \ The total number of automatic replies detected\ \ Example: 15\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=reply_count_automatic_unique)\ reply\_count\_automatic\_unique_integer_\ \ The number of unique automatic replies (first automatic reply per lead)\ \ Example: 12\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=reply_count_automatic_unique_by_step)\ reply\_count\_automatic\_unique\_by\_step_integer_\ \ The number of unique automatic replies per step\ \ Example: 18\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=link_click_count_unique)\ link\_click\_count\_unique_integer_\ \ The number of unique link clicks (first click per lead)\ \ Example: 600\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=link_click_count_unique_by_step)\ link\_click\_count\_unique\_by\_step_integer_\ \ The number of unique link clicks per step (first click per lead per step)\ \ Example: 720\ \ \] Response 1. 200 2. 400 3. 401 4. 404 5. 429 application/json \[\ {\ "campaign\_name": "My Test Campaign",\ "campaign\_id": "019c9b71-ee3b-70c6-8e78-b4ac05ee54ba",\ "campaign\_status": 1,\ "campaign\_is\_evergreen": true,\ "leads\_count": 1500,\ "contacted\_count": 1200,\ "emails\_sent\_count": 5000,\ "new\_leads\_contacted\_count": 200,\ "open\_count": 800,\ "open\_count\_unique": 750,\ "open\_count\_unique\_by\_step": 900,\ "reply\_count": 300,\ "reply\_count\_unique": 280,\ "reply\_count\_unique\_by\_step": 350,\ "reply\_count\_automatic": 15,\ "reply\_count\_automatic\_unique": 12,\ "reply\_count\_automatic\_unique\_by\_step": 18,\ "link\_click\_count": 800,\ "link\_click\_count\_unique": 600,\ "link\_click\_count\_unique\_by\_step": 720,\ "bounced\_count": 50,\ "unsubscribed\_count": 20,\ "completed\_count": 1100,\ "total\_opportunities": 10,\ "total\_opportunity\_value": 1000\ }\ \] #### Was this helpful? [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview) Get campaign(s) analytics overview ------------------------------------------------------------------------------------------------------------------- #### [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/request) Request 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. Security: ApiKeyAuth [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/request/query) Query [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=request&in=query&path=id) id_string__(uuid)_ A campaign ID to get the analytics overview for. Leave this field empty to get the analytics overview for all campaigns Example: id=019c9b71-ee3b-70c6-8e78-b4ad08832181 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=request&in=query&path=ids) ids_Array of strings__(uuid)_ Example: ids=019c9b71-ee3c-7ffc-873f-f9193acd9a12 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=request&in=query&path=start_date) start\_date_string_ Start date Example: start\_date=2024-01-01 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=request&in=query&path=end_date) end\_date_string_ End date Example: end\_date=2024-01-01 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=request&in=query&path=campaign_status) campaign\_status_number_ 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 | Example: campaign\_status=1 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=request&in=query&path=expand_crm_events) expand\_crm\_events_boolean_ 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). Default false Example: expand\_crm\_events=true get /api/v2/campaigns/analytics/overview * Instantly API Server https://api.instantly.ai/api/v2/campaigns/analytics/overview * Mock server https://developer.instantly.ai/\_mock/api/v2/api/v2/campaigns/analytics/overview curl * curl * JavaScript * Node.js * Python * Java * C# * PHP * Go * Ruby * R * Payload 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=019c9b71-ee3b-70c6-8e78-b4ad08832181&ids=019c9b71-ee3c-7ffc-873f-f9193acd9a12&start\_date=2024-01-01' \\ -H 'Authorization: Bearer ' Try it #### [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/response&c=200) Responses 1. 200 2. 400 3. 401 4. 404 5. 429 Default Response [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/response&c=200/body) Bodyapplication/json [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=open_count) open\_count_integer_ The total number of times the emails were opened, including duplicates Example: 800 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=open_count_unique) open\_count\_unique_integer_ The number of emails that got opened (for the first time only) Example: 800 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=open_count_unique_by_step) open\_count\_unique\_by\_step_integer_ The unique number of times the emails were opened (counted once per lead, step, and campaign) Example: 800 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=link_click_count) link\_click\_count_integer_ The number of links that got clicked Example: 800 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=link_click_count_unique) link\_click\_count\_unique_integer_ The number of links that got clicked (for the first time) Example: 800 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=link_click_count_unique_by_step) link\_click\_count\_unique\_by\_step_integer_ The unique number of links that got clicked, per step (counted once per lead, step, and campaign) Example: 800 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=reply_count) reply\_count_integer_ The total number of replies received (if a lead replies multiple times, each reply is counted) Example: 300 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=reply_count_unique) reply\_count\_unique_integer_ The number of unique replies (first reply per lead). Excludes automatic replies. Example: 300 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=reply_count_unique_by_step) reply\_count\_unique\_by\_step_integer_ The number of unique replies per step (first reply per lead per step). Excludes automatic replies. Example: 300 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=reply_count_automatic) reply\_count\_automatic_integer_ The total number of automatic replies received (e.g., out-of-office) Example: 50 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=reply_count_automatic_unique) reply\_count\_automatic\_unique_integer_ The number of unique leads that sent automatic replies Example: 45 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=reply_count_automatic_unique_by_step) reply\_count\_automatic\_unique\_by\_step_integer_ The unique number of automatic replies per step (counted once per lead, step, and campaign) Example: 45 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=bounced_count) bounced\_count_integer_ The number of bounced leads Example: 50 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=unsubscribed_count) unsubscribed\_count_integer_ The number of unsubscribed leads Example: 20 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=completed_count) completed\_count_integer_ The number of leads that the campaign was completed for Example: 1100 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=emails_sent_count) emails\_sent\_count_integer_ The total number of sent emails Example: 5000 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=contacted_count) contacted\_count_integer_ The total number of unique leads contacted Example: 4500 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=new_leads_contacted_count) new\_leads\_contacted\_count_integer_ The total number of new leads contacted Example: 200 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=total_opportunities) total\_opportunities_integer_ The total number of unique opportunities created Example: 10 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=total_opportunity_value) total\_opportunity\_value_number_ The total value of opportunities created Example: 1000 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=total_interested) total\_interested_integer_ The total number of interested opportunities created Example: 103 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=total_meeting_booked) total\_meeting\_booked_integer_ The total number of meeting booked opportunities created Example: 45 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=total_meeting_completed) total\_meeting\_completed_integer_ The total number of meeting completed opportunities created Example: 12 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=total_closed) total\_closed_integer_ The total number of closed opportunities created Example: 10 Response 1. 200 2. 400 3. 401 4. 404 5. 429 application/json { "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, "reply\_count\_automatic": 50, "reply\_count\_automatic\_unique": 45, "reply\_count\_automatic\_unique\_by\_step": 45, "bounced\_count": 50, "unsubscribed\_count": 20, "completed\_count": 1100, "emails\_sent\_count": 5000, "contacted\_count": 4500, "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 } #### Was this helpful? [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics) Get daily campaign analytics ---------------------------------------------------------------------------------------------------------- #### [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/request) Request Get campaign daily analytics Security: ApiKeyAuth [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/request/query) Query [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=request&in=query&path=campaign_id) campaign\_id_string__(uuid)_ Campaign ID (optional). Leave this field empty to get the analytics for all campaigns Example: campaign\_id=019c9b71-ee3c-7ffc-873f-f91a3db506d7 [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=request&in=query&path=start_date) start\_date_string_ Start date Example: start\_date=2024-01-01 [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=request&in=query&path=end_date) end\_date_string_ End date Example: end\_date=2024-01-01 [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=request&in=query&path=campaign_status) campaign\_status_number_ 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 | Example: campaign\_status=1 get /api/v2/campaigns/analytics/daily * Instantly API Server https://api.instantly.ai/api/v2/campaigns/analytics/daily * Mock server https://developer.instantly.ai/\_mock/api/v2/api/v2/campaigns/analytics/daily curl * curl * JavaScript * Node.js * Python * Java * C# * PHP * Go * Ruby * R * Payload curl -i -X GET \\ 'https://api.instantly.ai/api/v2/campaigns/analytics/daily?campaign\_id=019c9b71-ee3c-7ffc-873f-f91a3db506d7&campaign\_status=1&end\_date=2024-01-01&start\_date=2024-01-01' \\ -H 'Authorization: Bearer ' Try it #### [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/response&c=200) Responses 1. 200 2. 400 3. 401 4. 404 5. 429 Default Response [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/response&c=200/body) Bodyapplication/jsonArray \[\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=response&c=200&path=date)\ date_string_\ \ The date of the analytics entry, in YYYY-MM-DD format\ \ Example: "2025-03-01"\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=response&c=200&path=sent)\ sent_integer_\ \ The total number of sent emails\ \ Example: 5421\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=response&c=200&path=contacted)\ contacted_integer_\ \ The total number of unique contacts who received an email that day\ \ Example: 5000\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=response&c=200&path=new_leads_contacted)\ new\_leads\_contacted_integer_\ \ The total number of new leads contacted that day\ \ Example: 200\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=response&c=200&path=opened)\ opened_integer_\ \ The total number of opened emails\ \ Example: 99\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=response&c=200&path=unique_opened)\ unique\_opened_integer_\ \ The total number of unique opened emails\ \ Example: 60\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=response&c=200&path=replies)\ replies_integer_\ \ The total number of replies\ \ Example: 60\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=response&c=200&path=unique_replies)\ unique\_replies_integer_\ \ The total number of unique replies\ \ Example: 60\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=response&c=200&path=replies_automatic)\ replies\_automatic_integer_\ \ The total number of automatic replies detected\ \ Example: 5\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=response&c=200&path=unique_replies_automatic)\ unique\_replies\_automatic_integer_\ \ The total number of unique automatic replies detected\ \ Example: 4\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=response&c=200&path=clicks)\ clicks_integer_\ \ The total number of links clicked\ \ Example: 60\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=response&c=200&path=unique_clicks)\ unique\_clicks_integer_\ \ The total number of unique links clicked. Unique meaning from unique leads, not unique links. For instance, if a lead clicked a link 3 times, it will be counted as 1 unique click. If a lead clicked 3 different links, it will still be counted as 1 unique click\ \ Example: 60\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=response&c=200&path=opportunities)\ opportunities_integer_\ \ The total number of unique opportunities created from the campaign on that day\ \ Example: 5\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=response&c=200&path=unique_opportunities)\ unique\_opportunities_integer_\ \ The total number of unique opportunities created from unique leads from the campaign on that day\ \ Example: 3\ \ \] Response 1. 200 2. 400 3. 401 4. 404 5. 429 application/json \[\ {\ "date": "2025-03-01",\ "sent": 5421,\ "contacted": 5000,\ "new\_leads\_contacted": 200,\ "opened": 99,\ "unique\_opened": 60,\ "replies": 60,\ "unique\_replies": 60,\ "replies\_automatic": 5,\ "unique\_replies\_automatic": 4,\ "clicks": 60,\ "unique\_clicks": 60,\ "opportunities": 5,\ "unique\_opportunities": 3\ }\ \] #### Was this helpful? [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics) Get campaign steps analytics ---------------------------------------------------------------------------------------------------------- #### [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/request) Request Get campaign steps analytics Security: ApiKeyAuth [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/request/query) Query [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=request&in=query&path=campaign_id) campaign\_id_string__(uuid)_ Campaign ID (optional). Leave this field empty to get the analytics for all campaigns Example: campaign\_id=019c9b71-ee3d-7db5-8ef1-69bed0cb34fc [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=request&in=query&path=start_date) start\_date_string_ Start date Example: start\_date=2024-01-01 [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=request&in=query&path=end_date) end\_date_string_ End date Example: end\_date=2024-01-01 [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=request&in=query&path=include_opportunities_count) include\_opportunities\_count_boolean_ Whether to include the opportunities count per step. If this field is true then `opportunities` and `unique_opportunities` fields will be included in the response Default false Example: include\_opportunities\_count=true get /api/v2/campaigns/analytics/steps * Instantly API Server https://api.instantly.ai/api/v2/campaigns/analytics/steps * Mock server https://developer.instantly.ai/\_mock/api/v2/api/v2/campaigns/analytics/steps curl * curl * JavaScript * Node.js * Python * Java * C# * PHP * Go * Ruby * R * Payload curl -i -X GET \\ 'https://api.instantly.ai/api/v2/campaigns/analytics/steps?campaign\_id=019c9b71-ee3d-7db5-8ef1-69bed0cb34fc&end\_date=2024-01-01&include\_opportunities\_count=true&start\_date=2024-01-01' \\ -H 'Authorization: Bearer ' Try it #### [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/response&c=200) Responses 1. 200 2. 400 3. 401 4. 404 5. 429 Default Response [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/response&c=200/body) Bodyapplication/jsonArray \[\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=response&c=200&path=step)\ step_null or string_required\ \ The step number. When null it means we couldn't determine the step number for the event, for instance for list leads, which are not part of a campaign.\ \ Example: "1"\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=response&c=200&path=variant)\ variant_null or string_required\ \ The variant number, starting from 0. 0 = A, 1 = B, 2 = C, etc. When null it means we couldn't determine the variant for the event.\ \ Example: "0"\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=response&c=200&path=sent)\ sent_integer_required\ \ The total number of sent emails\ \ Example: 5421\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=response&c=200&path=opened)\ opened_integer_required\ \ The total number of opened emails\ \ Example: 99\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=response&c=200&path=unique_opened)\ unique\_opened_integer_required\ \ The total number of opened emails\ \ Example: 60\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=response&c=200&path=replies)\ replies_integer_required\ \ The total number of replies\ \ Example: 60\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=response&c=200&path=unique_replies)\ unique\_replies_integer_required\ \ The total number of replies\ \ Example: 60\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=response&c=200&path=replies_automatic)\ replies\_automatic_integer_required\ \ The total number of automatic replies detected\ \ Example: 5\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=response&c=200&path=unique_replies_automatic)\ unique\_replies\_automatic_integer_required\ \ The total number of unique automatic replies detected\ \ Example: 4\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=response&c=200&path=clicks)\ clicks_integer_required\ \ The total number of links clicked\ \ Example: 60\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=response&c=200&path=unique_clicks)\ unique\_clicks_integer_required\ \ The total number of unique links clicked. Unique meaning from unique leads, not unique links. For instance, if a lead clicked a link 3 times, it will be counted as 1 unique click. If a lead clicked 3 different links, it will still be counted as 1 unique click\ \ Example: 60\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=response&c=200&path=opportunities)\ opportunities_integer_\ \ The total number of opportunities created from this step. Included only if `include_opportunities_count` is `true`\ \ Example: 10\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=response&c=200&path=unique_opportunities)\ unique\_opportunities_integer_\ \ The total number of unique opportunities created from this step. Unique meaning unique per lead. If a lead has multiple opportunities, it will be counted as 1 unique opportunity. Included only if `include_opportunities_count` is `true`\ \ Example: 8\ \ \] Response 1. 200 2. 400 3. 401 4. 404 5. 429 application/json \[\ {\ "step": "1",\ "variant": "0",\ "sent": 5421,\ "opened": 99,\ "unique\_opened": 60,\ "replies": 60,\ "unique\_replies": 60,\ "replies\_automatic": 5,\ "unique\_replies\_automatic": 4,\ "clicks": 60,\ "unique\_clicks": 60,\ "opportunities": 10,\ "unique\_opportunities": 8\ }\ \] #### Was this helpful? [](https://developer.instantly.ai/api/v2/oauth) OAuth ----------------------------------------------------- OAuth authentication endpoints for connecting Google and Microsoft email accounts Operations post /api/v2/oauth/google/init post /api/v2/oauth/microsoft/init get /api/v2/oauth/session/status/{sessionId} \+ Show [](https://developer.instantly.ai/api/v2/account) Account --------------------------------------------------------- An email account that can be used to send campaigns Operations post /api/v2/accounts get /api/v2/accounts get /api/v2/accounts/{email} patch /api/v2/accounts/{email} delete /api/v2/accounts/{email} post /api/v2/accounts/warmup/enable post /api/v2/accounts/warmup/disable post /api/v2/accounts/warmup-analyticsShow 7 more... \+ Show [](https://developer.instantly.ai/api/v2/campaign) Campaign ----------------------------------------------------------- A campaign that can be sent to a list of recipients Operations post /api/v2/campaigns get /api/v2/campaigns post /api/v2/campaigns/{id}/activate post /api/v2/campaigns/{id}/pause get /api/v2/campaigns/{id} patch /api/v2/campaigns/{id} delete /api/v2/campaigns/{id} get /api/v2/campaigns/search-by-contactShow 11 more... \+ Show [](https://developer.instantly.ai/api/v2/email) Email ----------------------------------------------------- A campaign email, a reply, a manually sent email, or any other email that's visible in the Unibox Operations post /api/v2/emails/reply post /api/v2/emails/forward get /api/v2/emails get /api/v2/emails/{id} patch /api/v2/emails/{id} delete /api/v2/emails/{id} get /api/v2/emails/unread/count post /api/v2/emails/threads/{thread\_id}/mark-as-read \+ Show [](https://developer.instantly.ai/api/v2/emailverification) Email Verification ------------------------------------------------------------------------------ A single email verification Operations post /api/v2/email-verification get /api/v2/email-verification/{email} \+ Show [](https://developer.instantly.ai/api/v2/leadlist) Lead List ------------------------------------------------------------ A list used to store leads Operations post /api/v2/lead-lists get /api/v2/lead-lists get /api/v2/lead-lists/{id} patch /api/v2/lead-lists/{id} delete /api/v2/lead-lists/{id} get /api/v2/lead-lists/{id}/verification-stats \+ Show [](https://developer.instantly.ai/api/v2/inboxplacementtest) Inbox Placement Test --------------------------------------------------------------------------------- An inbox placement test Operations post /api/v2/inbox-placement-tests get /api/v2/inbox-placement-tests get /api/v2/inbox-placement-tests/{id} delete /api/v2/inbox-placement-tests/{id} patch /api/v2/inbox-placement-tests/{id} get /api/v2/inbox-placement-tests/email-service-provider-options \+ Show [](https://developer.instantly.ai/api/v2/inboxplacementanalytics) Inbox Placement Analytics ------------------------------------------------------------------------------------------- Analytics data for individual emails in inbox placement tests Operations get /api/v2/inbox-placement-analytics get /api/v2/inbox-placement-analytics/{id} post /api/v2/inbox-placement-analytics/stats-by-test-id post /api/v2/inbox-placement-analytics/deliverability-insights post /api/v2/inbox-placement-analytics/stats-by-date \+ Show [](https://developer.instantly.ai/api/v2/inboxplacementblacklistandspamassassinreport) Inbox Placement Blacklist & SpamAssassin Report -------------------------------------------------------------------------------------------------------------------------------------- Report data for an inbox placement test Operations get /api/v2/inbox-placement-reports get /api/v2/inbox-placement-reports/{id} \+ Show [](https://developer.instantly.ai/api/v2/apikey) API Key -------------------------------------------------------- API Key Operations post /api/v2/api-keys get /api/v2/api-keys delete /api/v2/api-keys/{id} \+ Show [](https://developer.instantly.ai/api/v2/accountcampaignmapping) Account Campaign Mapping ----------------------------------------------------------------------------------------- Account Campaign Mapping Operations get /api/v2/account-campaign-mappings/{email} \+ Show [](https://developer.instantly.ai/api/v2/lead) Lead --------------------------------------------------- A lead entity representing an individual lead Operations post /api/v2/leads delete /api/v2/leads post /api/v2/leads/list get /api/v2/leads/{id} patch /api/v2/leads/{id} delete /api/v2/leads/{id} post /api/v2/leads/merge post /api/v2/leads/update-interest-statusShow 5 more... \+ Show [](https://developer.instantly.ai/api/v2/backgroundjob) Background Job ---------------------------------------------------------------------- A background job that can be used to perform long-running tasks Operations get /api/v2/background-jobs get /api/v2/background-jobs/{id} \+ Show [](https://developer.instantly.ai/api/v2/customtag) Custom Tag -------------------------------------------------------------- A custom tag for organizing and categorizing accounts and campaigns. You can use them as filters in apis that list accounts and campaigns. Operations post /api/v2/custom-tags get /api/v2/custom-tags get /api/v2/custom-tags/{id} patch /api/v2/custom-tags/{id} delete /api/v2/custom-tags/{id} post /api/v2/custom-tags/toggle-resource \+ Show [](https://developer.instantly.ai/api/v2/customtagmapping) Custom Tag Mapping ----------------------------------------------------------------------------- This entity represents a tag being assigned to a specific campaign or email account. When an email account is assigned a tag, a new custom tag mapping entry is created, which connects the tag (`tag_id` field) with the email account (`resource_id` field). You can use it to see which tag si connected to which resource. Operations get /api/v2/custom-tag-mappings \+ Show [](https://developer.instantly.ai/api/v2/blocklistentry) Block List Entry ------------------------------------------------------------------------- A blocked email or domain Operations post /api/v2/block-lists-entries get /api/v2/block-lists-entries get /api/v2/block-lists-entries/{id} patch /api/v2/block-lists-entries/{id} delete /api/v2/block-lists-entries/{id} \+ Show [](https://developer.instantly.ai/api/v2/leadlabel) Lead Label -------------------------------------------------------------- A custom label for categorizing and managing leads Operations post /api/v2/lead-labels get /api/v2/lead-labels get /api/v2/lead-labels/{id} patch /api/v2/lead-labels/{id} delete /api/v2/lead-labels/{id} post /api/v2/lead-labels/ai-reply-label \+ Show [](https://developer.instantly.ai/api/v2/workspace) Workspace ------------------------------------------------------------- A workspace entity representing a workspace Operations get /api/v2/workspaces/current patch /api/v2/workspaces/current post /api/v2/workspaces/current/whitelabel-domain get /api/v2/workspaces/current/whitelabel-domain delete /api/v2/workspaces/current/whitelabel-domain post /api/v2/workspaces/current/change-owner \+ Show [](https://developer.instantly.ai/api/v2/supersearchenrichment) SuperSearch Enrichment -------------------------------------------------------------------------------------- An enrichment can take different forms, such as email enrichment or LinkedIn enrichment. Leads may be imported from SuperSearch using the dedicated endpoint, or enriched directly within a list or campaign by attaching an enrichment to it. Operations post /api/v2/supersearch-enrichment/enrich-leads-from-supersearch get /api/v2/supersearch-enrichment/{resource\_id} post /api/v2/supersearch-enrichment patch /api/v2/supersearch-enrichment/{resource\_id}/settings post /api/v2/supersearch-enrichment/ai get /api/v2/supersearch-enrichment/ai/{resource\_id}/in-progress get /api/v2/supersearch-enrichment/history/{resource\_id} post /api/v2/supersearch-enrichment/runShow 2 more... \+ Show [](https://developer.instantly.ai/api/v2/workspacegroupmember) 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 post /api/v2/workspace-group-members get /api/v2/workspace-group-members get /api/v2/workspace-group-members/{id} delete /api/v2/workspace-group-members/{id} get /api/v2/workspace-group-members/admin \+ Show [](https://developer.instantly.ai/api/v2/workspacemember) Workspace Member -------------------------------------------------------------------------- A member of a workspace with associated user details Operations post /api/v2/workspace-members get /api/v2/workspace-members get /api/v2/workspace-members/{id} patch /api/v2/workspace-members/{id} delete /api/v2/workspace-members/{id} \+ Show [](https://developer.instantly.ai/api/v2/campaignsubsequence) Campaign Subsequence ---------------------------------------------------------------------------------- A subsequence entity representing a follow-up sequence Operations post /api/v2/subsequences get /api/v2/subsequences post /api/v2/subsequences/{id}/duplicate post /api/v2/subsequences/{id}/pause post /api/v2/subsequences/{id}/resume get /api/v2/subsequences/{id} patch /api/v2/subsequences/{id} delete /api/v2/subsequences/{id}Show 1 more... \+ Show [](https://developer.instantly.ai/api/v2/auditlog) Audit Log ------------------------------------------------------------ Audit log records for tracking system activities Operations get /api/v2/audit-logs \+ Show [](https://developer.instantly.ai/api/v2/webhook) Webhook --------------------------------------------------------- A webhook subscription for receiving event notifications Operations get /api/v2/webhooks post /api/v2/webhooks get /api/v2/webhooks/{id} patch /api/v2/webhooks/{id} delete /api/v2/webhooks/{id} get /api/v2/webhooks/event-types post /api/v2/webhooks/{id}/test post /api/v2/webhooks/{id}/resume \+ Show [](https://developer.instantly.ai/api/v2/webhookevent) Webhook Event -------------------------------------------------------------------- A webhook event that was sent or attempted to be sent Operations get /api/v2/webhook-events get /api/v2/webhook-events/{id} get /api/v2/webhook-events/summary get /api/v2/webhook-events/summary-by-date \+ Show [](https://developer.instantly.ai/api/v2/dfyemailaccountorder) DFY Email Account Order -------------------------------------------------------------------------------------- A Done-For-You email account order Operations post /api/v2/dfy-email-account-orders get /api/v2/dfy-email-account-orders post /api/v2/dfy-email-account-orders/domains/similar post /api/v2/dfy-email-account-orders/domains/check post /api/v2/dfy-email-account-orders/domains/pre-warmed-up-list get /api/v2/dfy-email-account-orders/accounts post /api/v2/dfy-email-account-orders/accounts/cancel \+ Show [](https://developer.instantly.ai/api/v2/customprompttemplate) Custom Prompt Template ------------------------------------------------------------------------------------- Custom prompt templates for creating custom prompts \+ Show [](https://developer.instantly.ai/api/v2/salesflow) Sales Flow -------------------------------------------------------------- Manages how sales users view and interact with campaign and lead lists within the sales flow. \+ Show [](https://developer.instantly.ai/api/v2/emailtemplate) Email Template ---------------------------------------------------------------------- A campaign email template \+ Show [](https://developer.instantly.ai/api/v2/workspacebilling) Workspace Billing ---------------------------------------------------------------------------- Workspace Billing Operations get /api/v2/workspace-billing/plan-details get /api/v2/workspace-billing/subscription-details \+ Show [](https://developer.instantly.ai/api/v2/crmactions) CRM Actions ---------------------------------------------------------------- CRM related actions Operations get /api/v2/crm-actions/phone-numbers delete /api/v2/crm-actions/phone-numbers/{id} \+ Show [](https://developer.instantly.ai/api/v2/schemas) Schemas --------------------------------------------------------- \+ Show --- # Get daily campaign analytics [Analytics](https://developer.instantly.ai/api/v2/analytics) / Get daily campaign 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/ [](https://developer.instantly.ai/api/v2/analytics) Analytics ------------------------------------------------------------- Endpoints related to analytics Operations post /api/v2/accounts/warmup-analytics get /api/v2/accounts/analytics/daily post /api/v2/accounts/test/vitals get /api/v2/campaigns/analytics get /api/v2/campaigns/analytics/overview get /api/v2/campaigns/analytics/daily get /api/v2/campaigns/analytics/steps [](https://developer.instantly.ai/api/v2/analytics/getwarmupanalytics) Get warmup analytics ------------------------------------------------------------------------------------------- #### [](https://developer.instantly.ai/api/v2/analytics/getwarmupanalytics#analytics/getwarmupanalytics/request) Request Requires one of the following scopes: `accounts:read`, `accounts:all`, `all:read`, `all:all` Security: ApiKeyAuth [](https://developer.instantly.ai/api/v2/analytics/getwarmupanalytics#analytics/getwarmupanalytics/request/body) Bodyapplication/jsonrequired [](https://developer.instantly.ai/api/v2/analytics/getwarmupanalytics#analytics/getwarmupanalytics/t=request&path=emails) emails_Array of strings__\[ 1 .. 100 \] items_required List of emails to get warmup analytics for. The emails should be attached to accounts in your workspace. Example: \["user@example.com"\] post /api/v2/accounts/warmup-analytics * Instantly API Server https://api.instantly.ai/api/v2/accounts/warmup-analytics * Mock server https://developer.instantly.ai/\_mock/api/v2/api/v2/accounts/warmup-analytics curl * curl * JavaScript * Node.js * Python * Java * C# * PHP * Go * Ruby * R * Payload curl -i -X POST \\ https://api.instantly.ai/api/v2/accounts/warmup-analytics \\ -H 'Authorization: Bearer ' \\ -H 'Content-Type: application/json' \\ -d '{ "emails": \[\ "user@example.com"\ \] }' Try it #### [](https://developer.instantly.ai/api/v2/analytics/getwarmupanalytics#analytics/getwarmupanalytics/response&c=200) Responses 1. 200 2. 401 3. 429 Expand all Default Response [](https://developer.instantly.ai/api/v2/analytics/getwarmupanalytics#analytics/getwarmupanalytics/response&c=200/body) Bodyapplication/json [](https://developer.instantly.ai/api/v2/analytics/getwarmupanalytics#analytics/getwarmupanalytics/t=response&c=200&path=email_date_data) email\_date\_data_object_ 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}}} +Show property [](https://developer.instantly.ai/api/v2/analytics/getwarmupanalytics#analytics/getwarmupanalytics/t=response&c=200&path=aggregate_data) aggregate\_data_object_ 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}} +Show property Response 1. 200 2. 401 3. 429 application/json { "email\_date\_data": { "example1@example.com": { … }, "example2@example.com": { … } }, "aggregate\_data": { "example1@example.com": { … }, "example2@example.com": { … } } } #### Was this helpful? [](https://developer.instantly.ai/api/v2/analytics/getdailyaccountanalytics) Get daily account analytics -------------------------------------------------------------------------------------------------------- #### [](https://developer.instantly.ai/api/v2/analytics/getdailyaccountanalytics#analytics/getdailyaccountanalytics/request) Request Get daily account analytics showing the number of emails sent per day for each email account. Useful for tracking daily sending activity across your accounts. Security: ApiKeyAuth [](https://developer.instantly.ai/api/v2/analytics/getdailyaccountanalytics#analytics/getdailyaccountanalytics/request/query) Query [](https://developer.instantly.ai/api/v2/analytics/getdailyaccountanalytics#analytics/getdailyaccountanalytics/t=request&in=query&path=start_date) start\_date_string_ Start date for the analytics period (optional). If not provided, returns data for the last 30 days. Example: start\_date=2024-01-01 [](https://developer.instantly.ai/api/v2/analytics/getdailyaccountanalytics#analytics/getdailyaccountanalytics/t=request&in=query&path=end_date) end\_date_string_ End date for the analytics period (optional). If not provided, defaults to current date. Example: end\_date=2024-01-31 [](https://developer.instantly.ai/api/v2/analytics/getdailyaccountanalytics#analytics/getdailyaccountanalytics/t=request&in=query&path=emails) emails_Array of strings_ Filter by specific email accounts (optional). If not provided, returns data for all accounts in your workspace. Example: emails=user@example.com get /api/v2/accounts/analytics/daily * Instantly API Server https://api.instantly.ai/api/v2/accounts/analytics/daily * Mock server https://developer.instantly.ai/\_mock/api/v2/api/v2/accounts/analytics/daily curl * curl * JavaScript * Node.js * Python * Java * C# * PHP * Go * Ruby * R * Payload curl -i -X GET \\ 'https://api.instantly.ai/api/v2/accounts/analytics/daily?emails=user%40example.com&end\_date=2024-01-31&start\_date=2024-01-01' \\ -H 'Authorization: Bearer ' Try it #### [](https://developer.instantly.ai/api/v2/analytics/getdailyaccountanalytics#analytics/getdailyaccountanalytics/response&c=200) Responses 1. 200 2. 400 3. 401 4. 429 Default Response [](https://developer.instantly.ai/api/v2/analytics/getdailyaccountanalytics#analytics/getdailyaccountanalytics/response&c=200/body) Bodyapplication/jsonArray \[\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailyaccountanalytics#analytics/getdailyaccountanalytics/t=response&c=200&path=date)\ date_string_required\ \ The date of the analytics entry, in YYYY-MM-DD format\ \ Example: "2024-01-15"\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailyaccountanalytics#analytics/getdailyaccountanalytics/t=response&c=200&path=email_account)\ email\_account_string_required\ \ The email account that sent the emails\ \ Example: "user@example.com"\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailyaccountanalytics#analytics/getdailyaccountanalytics/t=response&c=200&path=sent)\ sent_integer_required\ \ The total number of campaign emails sent on this date by this account, including emails for subsequences\ \ Example: 150\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailyaccountanalytics#analytics/getdailyaccountanalytics/t=response&c=200&path=bounced)\ bounced_integer_required\ \ The number of emails that bounced on this date for this account for campaigns - including subsequences\ \ Example: 3\ \ \] Response 1. 200 2. 400 3. 401 4. 429 application/json \[\ {\ "date": "2024-01-15",\ "email\_account": "user@example.com",\ "sent": 150,\ "bounced": 3\ }\ \] #### Was this helpful? [](https://developer.instantly.ai/api/v2/analytics/testaccountvitals) Test account vitals ----------------------------------------------------------------------------------------- #### [](https://developer.instantly.ai/api/v2/analytics/testaccountvitals#analytics/testaccountvitals/request) Request Requires one of the following scopes: `accounts:read`, `accounts:all`, `all:read`, `all:all` Security: ApiKeyAuth [](https://developer.instantly.ai/api/v2/analytics/testaccountvitals#analytics/testaccountvitals/request/body) Bodyapplication/json [](https://developer.instantly.ai/api/v2/analytics/testaccountvitals#analytics/testaccountvitals/t=request&path=accounts) accounts_Array of strings_ Example: \["user@example.com"\] post /api/v2/accounts/test/vitals * Instantly API Server https://api.instantly.ai/api/v2/accounts/test/vitals * Mock server https://developer.instantly.ai/\_mock/api/v2/api/v2/accounts/test/vitals curl * curl * JavaScript * Node.js * Python * Java * C# * PHP * Go * Ruby * R * Payload curl -i -X POST \\ https://api.instantly.ai/api/v2/accounts/test/vitals \\ -H 'Authorization: Bearer ' \\ -H 'Content-Type: application/json' \\ -d '{}' Try it #### [](https://developer.instantly.ai/api/v2/analytics/testaccountvitals#analytics/testaccountvitals/response&c=200) Responses 1. 200 2. 400 3. 401 4. 429 Expand all Default Response [](https://developer.instantly.ai/api/v2/analytics/testaccountvitals#analytics/testaccountvitals/response&c=200/body) Bodyapplication/json [](https://developer.instantly.ai/api/v2/analytics/testaccountvitals#analytics/testaccountvitals/t=response&c=200&path=status) status_string_ Example: "success" [](https://developer.instantly.ai/api/v2/analytics/testaccountvitals#analytics/testaccountvitals/t=response&c=200&path=success_list) success\_list_Array of objects_ +Show 6 array properties [](https://developer.instantly.ai/api/v2/analytics/testaccountvitals#analytics/testaccountvitals/t=response&c=200&path=failure_list) failure\_list_Array of objects_ +Show 6 array properties Response 1. 200 2. 400 3. 401 4. 429 application/json { "status": "success", "success\_list": \[\ { … }\ \], "failure\_list": \[\ { … }\ \] } #### Was this helpful? [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics) Get campaign(s) analytics -------------------------------------------------------------------------------------------------- #### [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/request) 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 Security: ApiKeyAuth [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/request/query) Query [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=request&in=query&path=id) id_string__(uuid)_ A campaign ID to get the analytics for. Leave this field empty to get the analytics for all campaigns Example: id=019c9b71-ee3b-70c6-8e78-b4aa88251a46 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=request&in=query&path=ids) ids_Array of strings__(uuid)_ Example: ids=019c9b71-ee3b-70c6-8e78-b4abfdb12c1c [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=request&in=query&path=start_date) start\_date_string_ Start date Example: start\_date=2024-01-01 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=request&in=query&path=end_date) end\_date_string_ End date Example: end\_date=2024-01-01 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=request&in=query&path=exclude_total_leads_count) exclude\_total\_leads\_count_boolean_ Exclude the total leads from the result. Setting this to true will considerably decrease the response time Default false Example: exclude\_total\_leads\_count=true get /api/v2/campaigns/analytics * Instantly API Server https://api.instantly.ai/api/v2/campaigns/analytics * Mock server https://developer.instantly.ai/\_mock/api/v2/api/v2/campaigns/analytics curl * curl * JavaScript * Node.js * Python * Java * C# * PHP * Go * Ruby * R * Payload curl -i -X GET \\ 'https://api.instantly.ai/api/v2/campaigns/analytics?end\_date=2024-01-01&exclude\_total\_leads\_count=true&id=019c9b71-ee3b-70c6-8e78-b4aa88251a46&ids=019c9b71-ee3b-70c6-8e78-b4abfdb12c1c&start\_date=2024-01-01' \\ -H 'Authorization: Bearer ' Try it #### [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/response&c=200) Responses 1. 200 2. 400 3. 401 4. 404 5. 429 Default Response [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/response&c=200/body) Bodyapplication/jsonArray \[\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=campaign_name)\ campaign\_name_string_required\ \ The name of the campaign\ \ Example: "My Test Campaign"\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=campaign_id)\ campaign\_id_string__(uuid)_required\ \ The ID of the campaign\ \ Example: "019c9b71-ee3b-70c6-8e78-b4ac05ee54ba"\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=campaign_status)\ campaign\_status_number_required\ \ The campaign status\ \ | Enum Value | Description |\ | --- | --- |\ | 0 | Draft |\ | 1 | Active |\ | 2 | Paused |\ | 3 | Completed |\ | 4 | Running Subsequences |\ | \-99 | Account Suspended |\ | \-1 | Accounts Unhealthy |\ | \-2 | Bounce Protect |\ \ Example: 1\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=campaign_is_evergreen)\ campaign\_is\_evergreen_boolean_required\ \ Whether the campaign is evergreen\ \ Example: true\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=leads_count)\ leads\_count_integer_required\ \ The total number of leads\ \ Example: 1500\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=contacted_count)\ contacted\_count_integer_required\ \ Number of leads for whom the sequence has started\ \ Example: 1200\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=open_count)\ open\_count_integer_required\ \ The number of leads that opened at least one email\ \ Example: 800\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=reply_count)\ reply\_count_integer_required\ \ The total number of replies received (if a lead replies multiple times, each reply is counted)\ \ Example: 300\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=link_click_count)\ link\_click\_count_integer_required\ \ The number of links that got clicked\ \ Example: 800\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=bounced_count)\ bounced\_count_integer_required\ \ The number of bounced leads\ \ Example: 50\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=unsubscribed_count)\ unsubscribed\_count_integer_required\ \ The number of unsubscribed leads\ \ Example: 20\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=completed_count)\ completed\_count_integer_required\ \ The number of leads that the campaign was completed for\ \ Example: 1100\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=emails_sent_count)\ emails\_sent\_count_integer_required\ \ The total number of sent emails\ \ Example: 5000\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=new_leads_contacted_count)\ new\_leads\_contacted\_count_integer_required\ \ The total number of new leads contacted\ \ Example: 200\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=total_opportunities)\ total\_opportunities_integer_required\ \ The total number of unique opportunities created\ \ Example: 10\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=total_opportunity_value)\ total\_opportunity\_value_number_required\ \ The total value of opportunities created\ \ Example: 1000\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=open_count_unique)\ open\_count\_unique_integer_\ \ The number of unique email opens (first open per lead)\ \ Example: 750\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=open_count_unique_by_step)\ open\_count\_unique\_by\_step_integer_\ \ The number of unique email opens per step (first open per lead per step)\ \ Example: 900\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=reply_count_unique)\ reply\_count\_unique_integer_\ \ The number of unique replies (first reply per lead). Excludes automatic replies.\ \ Example: 280\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=reply_count_unique_by_step)\ reply\_count\_unique\_by\_step_integer_\ \ The number of unique replies per step (first reply per lead per step). Excludes automatic replies.\ \ Example: 350\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=reply_count_automatic)\ reply\_count\_automatic_integer_\ \ The total number of automatic replies detected\ \ Example: 15\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=reply_count_automatic_unique)\ reply\_count\_automatic\_unique_integer_\ \ The number of unique automatic replies (first automatic reply per lead)\ \ Example: 12\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=reply_count_automatic_unique_by_step)\ reply\_count\_automatic\_unique\_by\_step_integer_\ \ The number of unique automatic replies per step\ \ Example: 18\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=link_click_count_unique)\ link\_click\_count\_unique_integer_\ \ The number of unique link clicks (first click per lead)\ \ Example: 600\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalytics#analytics/getcampaignanalytics/t=response&c=200&path=link_click_count_unique_by_step)\ link\_click\_count\_unique\_by\_step_integer_\ \ The number of unique link clicks per step (first click per lead per step)\ \ Example: 720\ \ \] Response 1. 200 2. 400 3. 401 4. 404 5. 429 application/json \[\ {\ "campaign\_name": "My Test Campaign",\ "campaign\_id": "019c9b71-ee3b-70c6-8e78-b4ac05ee54ba",\ "campaign\_status": 1,\ "campaign\_is\_evergreen": true,\ "leads\_count": 1500,\ "contacted\_count": 1200,\ "emails\_sent\_count": 5000,\ "new\_leads\_contacted\_count": 200,\ "open\_count": 800,\ "open\_count\_unique": 750,\ "open\_count\_unique\_by\_step": 900,\ "reply\_count": 300,\ "reply\_count\_unique": 280,\ "reply\_count\_unique\_by\_step": 350,\ "reply\_count\_automatic": 15,\ "reply\_count\_automatic\_unique": 12,\ "reply\_count\_automatic\_unique\_by\_step": 18,\ "link\_click\_count": 800,\ "link\_click\_count\_unique": 600,\ "link\_click\_count\_unique\_by\_step": 720,\ "bounced\_count": 50,\ "unsubscribed\_count": 20,\ "completed\_count": 1100,\ "total\_opportunities": 10,\ "total\_opportunity\_value": 1000\ }\ \] #### Was this helpful? [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview) Get campaign(s) analytics overview ------------------------------------------------------------------------------------------------------------------- #### [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/request) Request 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. Security: ApiKeyAuth [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/request/query) Query [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=request&in=query&path=id) id_string__(uuid)_ A campaign ID to get the analytics overview for. Leave this field empty to get the analytics overview for all campaigns Example: id=019c9b71-ee3b-70c6-8e78-b4ad08832181 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=request&in=query&path=ids) ids_Array of strings__(uuid)_ Example: ids=019c9b71-ee3c-7ffc-873f-f9193acd9a12 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=request&in=query&path=start_date) start\_date_string_ Start date Example: start\_date=2024-01-01 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=request&in=query&path=end_date) end\_date_string_ End date Example: end\_date=2024-01-01 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=request&in=query&path=campaign_status) campaign\_status_number_ 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 | Example: campaign\_status=1 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=request&in=query&path=expand_crm_events) expand\_crm\_events_boolean_ 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). Default false Example: expand\_crm\_events=true get /api/v2/campaigns/analytics/overview * Instantly API Server https://api.instantly.ai/api/v2/campaigns/analytics/overview * Mock server https://developer.instantly.ai/\_mock/api/v2/api/v2/campaigns/analytics/overview curl * curl * JavaScript * Node.js * Python * Java * C# * PHP * Go * Ruby * R * Payload 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=019c9b71-ee3b-70c6-8e78-b4ad08832181&ids=019c9b71-ee3c-7ffc-873f-f9193acd9a12&start\_date=2024-01-01' \\ -H 'Authorization: Bearer ' Try it #### [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/response&c=200) Responses 1. 200 2. 400 3. 401 4. 404 5. 429 Default Response [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/response&c=200/body) Bodyapplication/json [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=open_count) open\_count_integer_ The total number of times the emails were opened, including duplicates Example: 800 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=open_count_unique) open\_count\_unique_integer_ The number of emails that got opened (for the first time only) Example: 800 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=open_count_unique_by_step) open\_count\_unique\_by\_step_integer_ The unique number of times the emails were opened (counted once per lead, step, and campaign) Example: 800 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=link_click_count) link\_click\_count_integer_ The number of links that got clicked Example: 800 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=link_click_count_unique) link\_click\_count\_unique_integer_ The number of links that got clicked (for the first time) Example: 800 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=link_click_count_unique_by_step) link\_click\_count\_unique\_by\_step_integer_ The unique number of links that got clicked, per step (counted once per lead, step, and campaign) Example: 800 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=reply_count) reply\_count_integer_ The total number of replies received (if a lead replies multiple times, each reply is counted) Example: 300 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=reply_count_unique) reply\_count\_unique_integer_ The number of unique replies (first reply per lead). Excludes automatic replies. Example: 300 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=reply_count_unique_by_step) reply\_count\_unique\_by\_step_integer_ The number of unique replies per step (first reply per lead per step). Excludes automatic replies. Example: 300 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=reply_count_automatic) reply\_count\_automatic_integer_ The total number of automatic replies received (e.g., out-of-office) Example: 50 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=reply_count_automatic_unique) reply\_count\_automatic\_unique_integer_ The number of unique leads that sent automatic replies Example: 45 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=reply_count_automatic_unique_by_step) reply\_count\_automatic\_unique\_by\_step_integer_ The unique number of automatic replies per step (counted once per lead, step, and campaign) Example: 45 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=bounced_count) bounced\_count_integer_ The number of bounced leads Example: 50 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=unsubscribed_count) unsubscribed\_count_integer_ The number of unsubscribed leads Example: 20 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=completed_count) completed\_count_integer_ The number of leads that the campaign was completed for Example: 1100 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=emails_sent_count) emails\_sent\_count_integer_ The total number of sent emails Example: 5000 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=contacted_count) contacted\_count_integer_ The total number of unique leads contacted Example: 4500 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=new_leads_contacted_count) new\_leads\_contacted\_count_integer_ The total number of new leads contacted Example: 200 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=total_opportunities) total\_opportunities_integer_ The total number of unique opportunities created Example: 10 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=total_opportunity_value) total\_opportunity\_value_number_ The total value of opportunities created Example: 1000 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=total_interested) total\_interested_integer_ The total number of interested opportunities created Example: 103 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=total_meeting_booked) total\_meeting\_booked_integer_ The total number of meeting booked opportunities created Example: 45 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=total_meeting_completed) total\_meeting\_completed_integer_ The total number of meeting completed opportunities created Example: 12 [](https://developer.instantly.ai/api/v2/analytics/getcampaignanalyticsoverview#analytics/getcampaignanalyticsoverview/t=response&c=200&path=total_closed) total\_closed_integer_ The total number of closed opportunities created Example: 10 Response 1. 200 2. 400 3. 401 4. 404 5. 429 application/json { "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, "reply\_count\_automatic": 50, "reply\_count\_automatic\_unique": 45, "reply\_count\_automatic\_unique\_by\_step": 45, "bounced\_count": 50, "unsubscribed\_count": 20, "completed\_count": 1100, "emails\_sent\_count": 5000, "contacted\_count": 4500, "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 } #### Was this helpful? [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics) Get daily campaign analytics ---------------------------------------------------------------------------------------------------------- #### [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/request) Request Get campaign daily analytics Security: ApiKeyAuth [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/request/query) Query [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=request&in=query&path=campaign_id) campaign\_id_string__(uuid)_ Campaign ID (optional). Leave this field empty to get the analytics for all campaigns Example: campaign\_id=019c9b71-ee3c-7ffc-873f-f91a3db506d7 [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=request&in=query&path=start_date) start\_date_string_ Start date Example: start\_date=2024-01-01 [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=request&in=query&path=end_date) end\_date_string_ End date Example: end\_date=2024-01-01 [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=request&in=query&path=campaign_status) campaign\_status_number_ 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 | Example: campaign\_status=1 get /api/v2/campaigns/analytics/daily * Instantly API Server https://api.instantly.ai/api/v2/campaigns/analytics/daily * Mock server https://developer.instantly.ai/\_mock/api/v2/api/v2/campaigns/analytics/daily curl * curl * JavaScript * Node.js * Python * Java * C# * PHP * Go * Ruby * R * Payload curl -i -X GET \\ 'https://api.instantly.ai/api/v2/campaigns/analytics/daily?campaign\_id=019c9b71-ee3c-7ffc-873f-f91a3db506d7&campaign\_status=1&end\_date=2024-01-01&start\_date=2024-01-01' \\ -H 'Authorization: Bearer ' Try it #### [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/response&c=200) Responses 1. 200 2. 400 3. 401 4. 404 5. 429 Default Response [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/response&c=200/body) Bodyapplication/jsonArray \[\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=response&c=200&path=date)\ date_string_\ \ The date of the analytics entry, in YYYY-MM-DD format\ \ Example: "2025-03-01"\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=response&c=200&path=sent)\ sent_integer_\ \ The total number of sent emails\ \ Example: 5421\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=response&c=200&path=contacted)\ contacted_integer_\ \ The total number of unique contacts who received an email that day\ \ Example: 5000\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=response&c=200&path=new_leads_contacted)\ new\_leads\_contacted_integer_\ \ The total number of new leads contacted that day\ \ Example: 200\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=response&c=200&path=opened)\ opened_integer_\ \ The total number of opened emails\ \ Example: 99\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=response&c=200&path=unique_opened)\ unique\_opened_integer_\ \ The total number of unique opened emails\ \ Example: 60\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=response&c=200&path=replies)\ replies_integer_\ \ The total number of replies\ \ Example: 60\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=response&c=200&path=unique_replies)\ unique\_replies_integer_\ \ The total number of unique replies\ \ Example: 60\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=response&c=200&path=replies_automatic)\ replies\_automatic_integer_\ \ The total number of automatic replies detected\ \ Example: 5\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=response&c=200&path=unique_replies_automatic)\ unique\_replies\_automatic_integer_\ \ The total number of unique automatic replies detected\ \ Example: 4\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=response&c=200&path=clicks)\ clicks_integer_\ \ The total number of links clicked\ \ Example: 60\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=response&c=200&path=unique_clicks)\ unique\_clicks_integer_\ \ The total number of unique links clicked. Unique meaning from unique leads, not unique links. For instance, if a lead clicked a link 3 times, it will be counted as 1 unique click. If a lead clicked 3 different links, it will still be counted as 1 unique click\ \ Example: 60\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=response&c=200&path=opportunities)\ opportunities_integer_\ \ The total number of unique opportunities created from the campaign on that day\ \ Example: 5\ \ [](https://developer.instantly.ai/api/v2/analytics/getdailycampaignanalytics#analytics/getdailycampaignanalytics/t=response&c=200&path=unique_opportunities)\ unique\_opportunities_integer_\ \ The total number of unique opportunities created from unique leads from the campaign on that day\ \ Example: 3\ \ \] Response 1. 200 2. 400 3. 401 4. 404 5. 429 application/json \[\ {\ "date": "2025-03-01",\ "sent": 5421,\ "contacted": 5000,\ "new\_leads\_contacted": 200,\ "opened": 99,\ "unique\_opened": 60,\ "replies": 60,\ "unique\_replies": 60,\ "replies\_automatic": 5,\ "unique\_replies\_automatic": 4,\ "clicks": 60,\ "unique\_clicks": 60,\ "opportunities": 5,\ "unique\_opportunities": 3\ }\ \] #### Was this helpful? [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics) Get campaign steps analytics ---------------------------------------------------------------------------------------------------------- #### [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/request) Request Get campaign steps analytics Security: ApiKeyAuth [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/request/query) Query [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=request&in=query&path=campaign_id) campaign\_id_string__(uuid)_ Campaign ID (optional). Leave this field empty to get the analytics for all campaigns Example: campaign\_id=019c9b71-ee3d-7db5-8ef1-69bed0cb34fc [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=request&in=query&path=start_date) start\_date_string_ Start date Example: start\_date=2024-01-01 [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=request&in=query&path=end_date) end\_date_string_ End date Example: end\_date=2024-01-01 [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=request&in=query&path=include_opportunities_count) include\_opportunities\_count_boolean_ Whether to include the opportunities count per step. If this field is true then `opportunities` and `unique_opportunities` fields will be included in the response Default false Example: include\_opportunities\_count=true get /api/v2/campaigns/analytics/steps * Instantly API Server https://api.instantly.ai/api/v2/campaigns/analytics/steps * Mock server https://developer.instantly.ai/\_mock/api/v2/api/v2/campaigns/analytics/steps curl * curl * JavaScript * Node.js * Python * Java * C# * PHP * Go * Ruby * R * Payload curl -i -X GET \\ 'https://api.instantly.ai/api/v2/campaigns/analytics/steps?campaign\_id=019c9b71-ee3d-7db5-8ef1-69bed0cb34fc&end\_date=2024-01-01&include\_opportunities\_count=true&start\_date=2024-01-01' \\ -H 'Authorization: Bearer ' Try it #### [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/response&c=200) Responses 1. 200 2. 400 3. 401 4. 404 5. 429 Default Response [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/response&c=200/body) Bodyapplication/jsonArray \[\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=response&c=200&path=step)\ step_null or string_required\ \ The step number. When null it means we couldn't determine the step number for the event, for instance for list leads, which are not part of a campaign.\ \ Example: "1"\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=response&c=200&path=variant)\ variant_null or string_required\ \ The variant number, starting from 0. 0 = A, 1 = B, 2 = C, etc. When null it means we couldn't determine the variant for the event.\ \ Example: "0"\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=response&c=200&path=sent)\ sent_integer_required\ \ The total number of sent emails\ \ Example: 5421\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=response&c=200&path=opened)\ opened_integer_required\ \ The total number of opened emails\ \ Example: 99\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=response&c=200&path=unique_opened)\ unique\_opened_integer_required\ \ The total number of opened emails\ \ Example: 60\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=response&c=200&path=replies)\ replies_integer_required\ \ The total number of replies\ \ Example: 60\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=response&c=200&path=unique_replies)\ unique\_replies_integer_required\ \ The total number of replies\ \ Example: 60\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=response&c=200&path=replies_automatic)\ replies\_automatic_integer_required\ \ The total number of automatic replies detected\ \ Example: 5\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=response&c=200&path=unique_replies_automatic)\ unique\_replies\_automatic_integer_required\ \ The total number of unique automatic replies detected\ \ Example: 4\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=response&c=200&path=clicks)\ clicks_integer_required\ \ The total number of links clicked\ \ Example: 60\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=response&c=200&path=unique_clicks)\ unique\_clicks_integer_required\ \ The total number of unique links clicked. Unique meaning from unique leads, not unique links. For instance, if a lead clicked a link 3 times, it will be counted as 1 unique click. If a lead clicked 3 different links, it will still be counted as 1 unique click\ \ Example: 60\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=response&c=200&path=opportunities)\ opportunities_integer_\ \ The total number of opportunities created from this step. Included only if `include_opportunities_count` is `true`\ \ Example: 10\ \ [](https://developer.instantly.ai/api/v2/analytics/getcampaignstepsanalytics#analytics/getcampaignstepsanalytics/t=response&c=200&path=unique_opportunities)\ unique\_opportunities_integer_\ \ The total number of unique opportunities created from this step. Unique meaning unique per lead. If a lead has multiple opportunities, it will be counted as 1 unique opportunity. Included only if `include_opportunities_count` is `true`\ \ Example: 8\ \ \] Response 1. 200 2. 400 3. 401 4. 404 5. 429 application/json \[\ {\ "step": "1",\ "variant": "0",\ "sent": 5421,\ "opened": 99,\ "unique\_opened": 60,\ "replies": 60,\ "unique\_replies": 60,\ "replies\_automatic": 5,\ "unique\_replies\_automatic": 4,\ "clicks": 60,\ "unique\_clicks": 60,\ "opportunities": 10,\ "unique\_opportunities": 8\ }\ \] #### Was this helpful? [](https://developer.instantly.ai/api/v2/oauth) OAuth ----------------------------------------------------- OAuth authentication endpoints for connecting Google and Microsoft email accounts Operations post /api/v2/oauth/google/init post /api/v2/oauth/microsoft/init get /api/v2/oauth/session/status/{sessionId} \+ Show [](https://developer.instantly.ai/api/v2/account) Account --------------------------------------------------------- An email account that can be used to send campaigns Operations post /api/v2/accounts get /api/v2/accounts get /api/v2/accounts/{email} patch /api/v2/accounts/{email} delete /api/v2/accounts/{email} post /api/v2/accounts/warmup/enable post /api/v2/accounts/warmup/disable post /api/v2/accounts/warmup-analyticsShow 7 more... \+ Show [](https://developer.instantly.ai/api/v2/campaign) Campaign ----------------------------------------------------------- A campaign that can be sent to a list of recipients Operations post /api/v2/campaigns get /api/v2/campaigns post /api/v2/campaigns/{id}/activate post /api/v2/campaigns/{id}/pause get /api/v2/campaigns/{id} patch /api/v2/campaigns/{id} delete /api/v2/campaigns/{id} get /api/v2/campaigns/search-by-contactShow 11 more... \+ Show [](https://developer.instantly.ai/api/v2/email) Email ----------------------------------------------------- A campaign email, a reply, a manually sent email, or any other email that's visible in the Unibox Operations post /api/v2/emails/reply post /api/v2/emails/forward get /api/v2/emails get /api/v2/emails/{id} patch /api/v2/emails/{id} delete /api/v2/emails/{id} get /api/v2/emails/unread/count post /api/v2/emails/threads/{thread\_id}/mark-as-read \+ Show [](https://developer.instantly.ai/api/v2/emailverification) Email Verification ------------------------------------------------------------------------------ A single email verification Operations post /api/v2/email-verification get /api/v2/email-verification/{email} \+ Show [](https://developer.instantly.ai/api/v2/leadlist) Lead List ------------------------------------------------------------ A list used to store leads Operations post /api/v2/lead-lists get /api/v2/lead-lists get /api/v2/lead-lists/{id} patch /api/v2/lead-lists/{id} delete /api/v2/lead-lists/{id} get /api/v2/lead-lists/{id}/verification-stats \+ Show [](https://developer.instantly.ai/api/v2/inboxplacementtest) Inbox Placement Test --------------------------------------------------------------------------------- An inbox placement test Operations post /api/v2/inbox-placement-tests get /api/v2/inbox-placement-tests get /api/v2/inbox-placement-tests/{id} delete /api/v2/inbox-placement-tests/{id} patch /api/v2/inbox-placement-tests/{id} get /api/v2/inbox-placement-tests/email-service-provider-options \+ Show [](https://developer.instantly.ai/api/v2/inboxplacementanalytics) Inbox Placement Analytics ------------------------------------------------------------------------------------------- Analytics data for individual emails in inbox placement tests Operations get /api/v2/inbox-placement-analytics get /api/v2/inbox-placement-analytics/{id} post /api/v2/inbox-placement-analytics/stats-by-test-id post /api/v2/inbox-placement-analytics/deliverability-insights post /api/v2/inbox-placement-analytics/stats-by-date \+ Show [](https://developer.instantly.ai/api/v2/inboxplacementblacklistandspamassassinreport) Inbox Placement Blacklist & SpamAssassin Report -------------------------------------------------------------------------------------------------------------------------------------- Report data for an inbox placement test Operations get /api/v2/inbox-placement-reports get /api/v2/inbox-placement-reports/{id} \+ Show [](https://developer.instantly.ai/api/v2/apikey) API Key -------------------------------------------------------- API Key Operations post /api/v2/api-keys get /api/v2/api-keys delete /api/v2/api-keys/{id} \+ Show [](https://developer.instantly.ai/api/v2/accountcampaignmapping) Account Campaign Mapping ----------------------------------------------------------------------------------------- Account Campaign Mapping Operations get /api/v2/account-campaign-mappings/{email} \+ Show [](https://developer.instantly.ai/api/v2/lead) Lead --------------------------------------------------- A lead entity representing an individual lead Operations post /api/v2/leads delete /api/v2/leads post /api/v2/leads/list get /api/v2/leads/{id} patch /api/v2/leads/{id} delete /api/v2/leads/{id} post /api/v2/leads/merge post /api/v2/leads/update-interest-statusShow 5 more... \+ Show [](https://developer.instantly.ai/api/v2/backgroundjob) Background Job ---------------------------------------------------------------------- A background job that can be used to perform long-running tasks Operations get /api/v2/background-jobs get /api/v2/background-jobs/{id} \+ Show [](https://developer.instantly.ai/api/v2/customtag) Custom Tag -------------------------------------------------------------- A custom tag for organizing and categorizing accounts and campaigns. You can use them as filters in apis that list accounts and campaigns. Operations post /api/v2/custom-tags get /api/v2/custom-tags get /api/v2/custom-tags/{id} patch /api/v2/custom-tags/{id} delete /api/v2/custom-tags/{id} post /api/v2/custom-tags/toggle-resource \+ Show [](https://developer.instantly.ai/api/v2/customtagmapping) Custom Tag Mapping ----------------------------------------------------------------------------- This entity represents a tag being assigned to a specific campaign or email account. When an email account is assigned a tag, a new custom tag mapping entry is created, which connects the tag (`tag_id` field) with the email account (`resource_id` field). You can use it to see which tag si connected to which resource. Operations get /api/v2/custom-tag-mappings \+ Show [](https://developer.instantly.ai/api/v2/blocklistentry) Block List Entry ------------------------------------------------------------------------- A blocked email or domain Operations post /api/v2/block-lists-entries get /api/v2/block-lists-entries get /api/v2/block-lists-entries/{id} patch /api/v2/block-lists-entries/{id} delete /api/v2/block-lists-entries/{id} \+ Show [](https://developer.instantly.ai/api/v2/leadlabel) Lead Label -------------------------------------------------------------- A custom label for categorizing and managing leads Operations post /api/v2/lead-labels get /api/v2/lead-labels get /api/v2/lead-labels/{id} patch /api/v2/lead-labels/{id} delete /api/v2/lead-labels/{id} post /api/v2/lead-labels/ai-reply-label \+ Show [](https://developer.instantly.ai/api/v2/workspace) Workspace ------------------------------------------------------------- A workspace entity representing a workspace Operations get /api/v2/workspaces/current patch /api/v2/workspaces/current post /api/v2/workspaces/current/whitelabel-domain get /api/v2/workspaces/current/whitelabel-domain delete /api/v2/workspaces/current/whitelabel-domain post /api/v2/workspaces/current/change-owner \+ Show [](https://developer.instantly.ai/api/v2/supersearchenrichment) SuperSearch Enrichment -------------------------------------------------------------------------------------- An enrichment can take different forms, such as email enrichment or LinkedIn enrichment. Leads may be imported from SuperSearch using the dedicated endpoint, or enriched directly within a list or campaign by attaching an enrichment to it. Operations post /api/v2/supersearch-enrichment/enrich-leads-from-supersearch get /api/v2/supersearch-enrichment/{resource\_id} post /api/v2/supersearch-enrichment patch /api/v2/supersearch-enrichment/{resource\_id}/settings post /api/v2/supersearch-enrichment/ai get /api/v2/supersearch-enrichment/ai/{resource\_id}/in-progress get /api/v2/supersearch-enrichment/history/{resource\_id} post /api/v2/supersearch-enrichment/runShow 2 more... \+ Show [](https://developer.instantly.ai/api/v2/workspacegroupmember) 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 post /api/v2/workspace-group-members get /api/v2/workspace-group-members get /api/v2/workspace-group-members/{id} delete /api/v2/workspace-group-members/{id} get /api/v2/workspace-group-members/admin \+ Show [](https://developer.instantly.ai/api/v2/workspacemember) Workspace Member -------------------------------------------------------------------------- A member of a workspace with associated user details Operations post /api/v2/workspace-members get /api/v2/workspace-members get /api/v2/workspace-members/{id} patch /api/v2/workspace-members/{id} delete /api/v2/workspace-members/{id} \+ Show [](https://developer.instantly.ai/api/v2/campaignsubsequence) Campaign Subsequence ---------------------------------------------------------------------------------- A subsequence entity representing a follow-up sequence Operations post /api/v2/subsequences get /api/v2/subsequences post /api/v2/subsequences/{id}/duplicate post /api/v2/subsequences/{id}/pause post /api/v2/subsequences/{id}/resume get /api/v2/subsequences/{id} patch /api/v2/subsequences/{id} delete /api/v2/subsequences/{id}Show 1 more... \+ Show [](https://developer.instantly.ai/api/v2/auditlog) Audit Log ------------------------------------------------------------ Audit log records for tracking system activities Operations get /api/v2/audit-logs \+ Show [](https://developer.instantly.ai/api/v2/webhook) Webhook --------------------------------------------------------- A webhook subscription for receiving event notifications Operations get /api/v2/webhooks post /api/v2/webhooks get /api/v2/webhooks/{id} patch /api/v2/webhooks/{id} delete /api/v2/webhooks/{id} get /api/v2/webhooks/event-types post /api/v2/webhooks/{id}/test post /api/v2/webhooks/{id}/resume \+ Show [](https://developer.instantly.ai/api/v2/webhookevent) Webhook Event -------------------------------------------------------------------- A webhook event that was sent or attempted to be sent Operations get /api/v2/webhook-events get /api/v2/webhook-events/{id} get /api/v2/webhook-events/summary get /api/v2/webhook-events/summary-by-date \+ Show [](https://developer.instantly.ai/api/v2/dfyemailaccountorder) DFY Email Account Order -------------------------------------------------------------------------------------- A Done-For-You email account order Operations post /api/v2/dfy-email-account-orders get /api/v2/dfy-email-account-orders post /api/v2/dfy-email-account-orders/domains/similar post /api/v2/dfy-email-account-orders/domains/check post /api/v2/dfy-email-account-orders/domains/pre-warmed-up-list get /api/v2/dfy-email-account-orders/accounts post /api/v2/dfy-email-account-orders/accounts/cancel \+ Show [](https://developer.instantly.ai/api/v2/customprompttemplate) Custom Prompt Template ------------------------------------------------------------------------------------- Custom prompt templates for creating custom prompts \+ Show [](https://developer.instantly.ai/api/v2/salesflow) Sales Flow -------------------------------------------------------------- Manages how sales users view and interact with campaign and lead lists within the sales flow. \+ Show [](https://developer.instantly.ai/api/v2/emailtemplate) Email Template ---------------------------------------------------------------------- A campaign email template \+ Show [](https://developer.instantly.ai/api/v2/workspacebilling) Workspace Billing ---------------------------------------------------------------------------- Workspace Billing Operations get /api/v2/workspace-billing/plan-details get /api/v2/workspace-billing/subscription-details \+ Show [](https://developer.instantly.ai/api/v2/crmactions) CRM Actions ---------------------------------------------------------------- CRM related actions Operations get /api/v2/crm-actions/phone-numbers delete /api/v2/crm-actions/phone-numbers/{id} \+ Show [](https://developer.instantly.ai/api/v2/schemas) Schemas --------------------------------------------------------- \+ Show --- # OAuth [OAuth](https://developer.instantly.ai/api/v2/oauth) 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/ [](https://developer.instantly.ai/api/v2/analytics) Analytics ------------------------------------------------------------- Endpoints related to analytics Operations post /api/v2/accounts/warmup-analytics get /api/v2/accounts/analytics/daily post /api/v2/accounts/test/vitals get /api/v2/campaigns/analytics get /api/v2/campaigns/analytics/overview get /api/v2/campaigns/analytics/daily get /api/v2/campaigns/analytics/steps \+ Show [](https://developer.instantly.ai/api/v2/oauth) OAuth ----------------------------------------------------- OAuth authentication endpoints for connecting Google and Microsoft email accounts Operations post /api/v2/oauth/google/init post /api/v2/oauth/microsoft/init get /api/v2/oauth/session/status/{sessionId} [](https://developer.instantly.ai/api/v2/oauth/initgoogleoauth) Initialize google oauth --------------------------------------------------------------------------------------- #### [](https://developer.instantly.ai/api/v2/oauth/initgoogleoauth#oauth/initgoogleoauth/request) Request Creates an OAuth session and returns the Google authorization URL. The user should be redirected to auth\_url to complete the OAuth flow. Poll the status endpoint to check for completion. Security: ApiKeyAuth post /api/v2/oauth/google/init * Instantly API Server https://api.instantly.ai/api/v2/oauth/google/init * Mock server https://developer.instantly.ai/\_mock/api/v2/api/v2/oauth/google/init curl * curl * JavaScript * Node.js * Python * Java * C# * PHP * Go * Ruby * R * Payload curl -i -X POST \\ https://api.instantly.ai/api/v2/oauth/google/init \\ -H 'Authorization: Bearer ' Try it #### [](https://developer.instantly.ai/api/v2/oauth/initgoogleoauth#oauth/initgoogleoauth/response&c=200) Responses 1. 200 Default Response [](https://developer.instantly.ai/api/v2/oauth/initgoogleoauth#oauth/initgoogleoauth/response&c=200/body) Bodyapplication/json [](https://developer.instantly.ai/api/v2/oauth/initgoogleoauth#oauth/initgoogleoauth/t=response&c=200&path=session_id) session\_id_string_ Session ID for polling status Example: "abc123def456" [](https://developer.instantly.ai/api/v2/oauth/initgoogleoauth#oauth/initgoogleoauth/t=response&c=200&path=auth_url) auth\_url_string_ Google authorization URL to redirect user to Example: "https://accounts.google.com/o/oauth2/auth?..." [](https://developer.instantly.ai/api/v2/oauth/initgoogleoauth#oauth/initgoogleoauth/t=response&c=200&path=expires_at) expires\_at_string__(date-time)_ Session expiry time (10 minutes from creation) Example: "2026-01-14T12:30:00.000Z" Response 1. 200 application/json { "session\_id": "abc123def456", "auth\_url": "https://accounts.google.com/o/oauth2/auth?...", "expires\_at": "2026-01-14T12:30:00.000Z" } #### Was this helpful? [](https://developer.instantly.ai/api/v2/oauth/initmicrosoftoauth) Initialize microsoft oauth --------------------------------------------------------------------------------------------- #### [](https://developer.instantly.ai/api/v2/oauth/initmicrosoftoauth#oauth/initmicrosoftoauth/request) Request Creates an OAuth session and returns the Microsoft authorization URL. The user should be redirected to auth\_url to complete the OAuth flow. Poll the status endpoint to check for completion. Security: ApiKeyAuth post /api/v2/oauth/microsoft/init * Instantly API Server https://api.instantly.ai/api/v2/oauth/microsoft/init * Mock server https://developer.instantly.ai/\_mock/api/v2/api/v2/oauth/microsoft/init curl * curl * JavaScript * Node.js * Python * Java * C# * PHP * Go * Ruby * R * Payload curl -i -X POST \\ https://api.instantly.ai/api/v2/oauth/microsoft/init \\ -H 'Authorization: Bearer ' Try it #### [](https://developer.instantly.ai/api/v2/oauth/initmicrosoftoauth#oauth/initmicrosoftoauth/response&c=200) Responses 1. 200 Default Response [](https://developer.instantly.ai/api/v2/oauth/initmicrosoftoauth#oauth/initmicrosoftoauth/response&c=200/body) Bodyapplication/json [](https://developer.instantly.ai/api/v2/oauth/initmicrosoftoauth#oauth/initmicrosoftoauth/t=response&c=200&path=session_id) session\_id_string_ Session ID for polling status Example: "abc123def456" [](https://developer.instantly.ai/api/v2/oauth/initmicrosoftoauth#oauth/initmicrosoftoauth/t=response&c=200&path=auth_url) auth\_url_string_ Microsoft authorization URL to redirect user to Example: "https://login.microsoftonline.com/common/oauth2/v2.0/authorize?..." [](https://developer.instantly.ai/api/v2/oauth/initmicrosoftoauth#oauth/initmicrosoftoauth/t=response&c=200&path=expires_at) expires\_at_string__(date-time)_ Session expiry time (10 minutes from creation) Example: "2026-01-14T12:30:00.000Z" Response 1. 200 application/json { "session\_id": "abc123def456", "auth\_url": "https://login.microsoftonline.com/common/oauth2/v2.0/authorize?...", "expires\_at": "2026-01-14T12:30:00.000Z" } #### Was this helpful? [](https://developer.instantly.ai/api/v2/oauth/getoauthsessionstatus) Get oauth session status ---------------------------------------------------------------------------------------------- #### [](https://developer.instantly.ai/api/v2/oauth/getoauthsessionstatus#oauth/getoauthsessionstatus/request) Request Poll this endpoint to check the OAuth session result. Works for both Google and Microsoft OAuth sessions. Returns pending while waiting, success with account details when complete, or error if something went wrong. Sessions expire after 10 minutes. Security: ApiKeyAuth [](https://developer.instantly.ai/api/v2/oauth/getoauthsessionstatus#oauth/getoauthsessionstatus/request/path) Path [](https://developer.instantly.ai/api/v2/oauth/getoauthsessionstatus#oauth/getoauthsessionstatus/t=request&in=path&path=sessionid) sessionId_string_required Session ID from init response Example: abc123def456 get /api/v2/oauth/session/status/{sessionId} * Instantly API Server https://api.instantly.ai/api/v2/oauth/session/status/{sessionId} * Mock server https://developer.instantly.ai/\_mock/api/v2/api/v2/oauth/session/status/{sessionId} curl * curl * JavaScript * Node.js * Python * Java * C# * PHP * Go * Ruby * R * Payload curl -i -X GET \\ https://api.instantly.ai/api/v2/oauth/session/status/abc123def456 \\ -H 'Authorization: Bearer ' Try it #### [](https://developer.instantly.ai/api/v2/oauth/getoauthsessionstatus#oauth/getoauthsessionstatus/response&c=200) Responses 1. 200 Default Response [](https://developer.instantly.ai/api/v2/oauth/getoauthsessionstatus#oauth/getoauthsessionstatus/response&c=200/body) Bodyapplication/json [](https://developer.instantly.ai/api/v2/oauth/getoauthsessionstatus#oauth/getoauthsessionstatus/t=response&c=200&path=status) status_string_ Current status of the OAuth session Enum"pending""success""error""expired" Example: "success" [](https://developer.instantly.ai/api/v2/oauth/getoauthsessionstatus#oauth/getoauthsessionstatus/t=response&c=200&path=email) email_string_ Email of the connected account (on success) Example: "user@example.com" [](https://developer.instantly.ai/api/v2/oauth/getoauthsessionstatus#oauth/getoauthsessionstatus/t=response&c=200&path=name) name_string_ Name of the account owner (on success) Example: "John Doe" [](https://developer.instantly.ai/api/v2/oauth/getoauthsessionstatus#oauth/getoauthsessionstatus/t=response&c=200&path=error) error_string_ Error code (on error) Example: "access\_denied" [](https://developer.instantly.ai/api/v2/oauth/getoauthsessionstatus#oauth/getoauthsessionstatus/t=response&c=200&path=error_description) error\_description_string_ Human-readable error description (on error) Example: "User denied access to the application" Response 1. 200 application/json { "status": "success", "email": "user@example.com", "name": "John Doe", "error": "access\_denied", "error\_description": "User denied access to the application" } #### Was this helpful? [](https://developer.instantly.ai/api/v2/account) Account --------------------------------------------------------- An email account that can be used to send campaigns Operations post /api/v2/accounts get /api/v2/accounts get /api/v2/accounts/{email} patch /api/v2/accounts/{email} delete /api/v2/accounts/{email} post /api/v2/accounts/warmup/enable post /api/v2/accounts/warmup/disable post /api/v2/accounts/warmup-analyticsShow 7 more... \+ Show [](https://developer.instantly.ai/api/v2/campaign) Campaign ----------------------------------------------------------- A campaign that can be sent to a list of recipients Operations post /api/v2/campaigns get /api/v2/campaigns post /api/v2/campaigns/{id}/activate post /api/v2/campaigns/{id}/pause get /api/v2/campaigns/{id} patch /api/v2/campaigns/{id} delete /api/v2/campaigns/{id} get /api/v2/campaigns/search-by-contactShow 11 more... \+ Show [](https://developer.instantly.ai/api/v2/email) Email ----------------------------------------------------- A campaign email, a reply, a manually sent email, or any other email that's visible in the Unibox Operations post /api/v2/emails/reply post /api/v2/emails/forward get /api/v2/emails get /api/v2/emails/{id} patch /api/v2/emails/{id} delete /api/v2/emails/{id} get /api/v2/emails/unread/count post /api/v2/emails/threads/{thread\_id}/mark-as-read \+ Show [](https://developer.instantly.ai/api/v2/emailverification) Email Verification ------------------------------------------------------------------------------ A single email verification Operations post /api/v2/email-verification get /api/v2/email-verification/{email} \+ Show [](https://developer.instantly.ai/api/v2/leadlist) Lead List ------------------------------------------------------------ A list used to store leads Operations post /api/v2/lead-lists get /api/v2/lead-lists get /api/v2/lead-lists/{id} patch /api/v2/lead-lists/{id} delete /api/v2/lead-lists/{id} get /api/v2/lead-lists/{id}/verification-stats \+ Show [](https://developer.instantly.ai/api/v2/inboxplacementtest) Inbox Placement Test --------------------------------------------------------------------------------- An inbox placement test Operations post /api/v2/inbox-placement-tests get /api/v2/inbox-placement-tests get /api/v2/inbox-placement-tests/{id} delete /api/v2/inbox-placement-tests/{id} patch /api/v2/inbox-placement-tests/{id} get /api/v2/inbox-placement-tests/email-service-provider-options \+ Show [](https://developer.instantly.ai/api/v2/inboxplacementanalytics) Inbox Placement Analytics ------------------------------------------------------------------------------------------- Analytics data for individual emails in inbox placement tests Operations get /api/v2/inbox-placement-analytics get /api/v2/inbox-placement-analytics/{id} post /api/v2/inbox-placement-analytics/stats-by-test-id post /api/v2/inbox-placement-analytics/deliverability-insights post /api/v2/inbox-placement-analytics/stats-by-date \+ Show [](https://developer.instantly.ai/api/v2/inboxplacementblacklistandspamassassinreport) Inbox Placement Blacklist & SpamAssassin Report -------------------------------------------------------------------------------------------------------------------------------------- Report data for an inbox placement test Operations get /api/v2/inbox-placement-reports get /api/v2/inbox-placement-reports/{id} \+ Show [](https://developer.instantly.ai/api/v2/apikey) API Key -------------------------------------------------------- API Key Operations post /api/v2/api-keys get /api/v2/api-keys delete /api/v2/api-keys/{id} \+ Show [](https://developer.instantly.ai/api/v2/accountcampaignmapping) Account Campaign Mapping ----------------------------------------------------------------------------------------- Account Campaign Mapping Operations get /api/v2/account-campaign-mappings/{email} \+ Show [](https://developer.instantly.ai/api/v2/lead) Lead --------------------------------------------------- A lead entity representing an individual lead Operations post /api/v2/leads delete /api/v2/leads post /api/v2/leads/list get /api/v2/leads/{id} patch /api/v2/leads/{id} delete /api/v2/leads/{id} post /api/v2/leads/merge post /api/v2/leads/update-interest-statusShow 5 more... \+ Show [](https://developer.instantly.ai/api/v2/backgroundjob) Background Job ---------------------------------------------------------------------- A background job that can be used to perform long-running tasks Operations get /api/v2/background-jobs get /api/v2/background-jobs/{id} \+ Show [](https://developer.instantly.ai/api/v2/customtag) Custom Tag -------------------------------------------------------------- A custom tag for organizing and categorizing accounts and campaigns. You can use them as filters in apis that list accounts and campaigns. Operations post /api/v2/custom-tags get /api/v2/custom-tags get /api/v2/custom-tags/{id} patch /api/v2/custom-tags/{id} delete /api/v2/custom-tags/{id} post /api/v2/custom-tags/toggle-resource \+ Show [](https://developer.instantly.ai/api/v2/customtagmapping) Custom Tag Mapping ----------------------------------------------------------------------------- This entity represents a tag being assigned to a specific campaign or email account. When an email account is assigned a tag, a new custom tag mapping entry is created, which connects the tag (`tag_id` field) with the email account (`resource_id` field). You can use it to see which tag si connected to which resource. Operations get /api/v2/custom-tag-mappings \+ Show [](https://developer.instantly.ai/api/v2/blocklistentry) Block List Entry ------------------------------------------------------------------------- A blocked email or domain Operations post /api/v2/block-lists-entries get /api/v2/block-lists-entries get /api/v2/block-lists-entries/{id} patch /api/v2/block-lists-entries/{id} delete /api/v2/block-lists-entries/{id} \+ Show [](https://developer.instantly.ai/api/v2/leadlabel) Lead Label -------------------------------------------------------------- A custom label for categorizing and managing leads Operations post /api/v2/lead-labels get /api/v2/lead-labels get /api/v2/lead-labels/{id} patch /api/v2/lead-labels/{id} delete /api/v2/lead-labels/{id} post /api/v2/lead-labels/ai-reply-label \+ Show [](https://developer.instantly.ai/api/v2/workspace) Workspace ------------------------------------------------------------- A workspace entity representing a workspace Operations get /api/v2/workspaces/current patch /api/v2/workspaces/current post /api/v2/workspaces/current/whitelabel-domain get /api/v2/workspaces/current/whitelabel-domain delete /api/v2/workspaces/current/whitelabel-domain post /api/v2/workspaces/current/change-owner \+ Show [](https://developer.instantly.ai/api/v2/supersearchenrichment) SuperSearch Enrichment -------------------------------------------------------------------------------------- An enrichment can take different forms, such as email enrichment or LinkedIn enrichment. Leads may be imported from SuperSearch using the dedicated endpoint, or enriched directly within a list or campaign by attaching an enrichment to it. Operations post /api/v2/supersearch-enrichment/enrich-leads-from-supersearch get /api/v2/supersearch-enrichment/{resource\_id} post /api/v2/supersearch-enrichment patch /api/v2/supersearch-enrichment/{resource\_id}/settings post /api/v2/supersearch-enrichment/ai get /api/v2/supersearch-enrichment/ai/{resource\_id}/in-progress get /api/v2/supersearch-enrichment/history/{resource\_id} post /api/v2/supersearch-enrichment/runShow 2 more... \+ Show [](https://developer.instantly.ai/api/v2/workspacegroupmember) 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 post /api/v2/workspace-group-members get /api/v2/workspace-group-members get /api/v2/workspace-group-members/{id} delete /api/v2/workspace-group-members/{id} get /api/v2/workspace-group-members/admin \+ Show [](https://developer.instantly.ai/api/v2/workspacemember) Workspace Member -------------------------------------------------------------------------- A member of a workspace with associated user details Operations post /api/v2/workspace-members get /api/v2/workspace-members get /api/v2/workspace-members/{id} patch /api/v2/workspace-members/{id} delete /api/v2/workspace-members/{id} \+ Show [](https://developer.instantly.ai/api/v2/campaignsubsequence) Campaign Subsequence ---------------------------------------------------------------------------------- A subsequence entity representing a follow-up sequence Operations post /api/v2/subsequences get /api/v2/subsequences post /api/v2/subsequences/{id}/duplicate post /api/v2/subsequences/{id}/pause post /api/v2/subsequences/{id}/resume get /api/v2/subsequences/{id} patch /api/v2/subsequences/{id} delete /api/v2/subsequences/{id}Show 1 more... \+ Show [](https://developer.instantly.ai/api/v2/auditlog) Audit Log ------------------------------------------------------------ Audit log records for tracking system activities Operations get /api/v2/audit-logs \+ Show [](https://developer.instantly.ai/api/v2/webhook) Webhook --------------------------------------------------------- A webhook subscription for receiving event notifications Operations get /api/v2/webhooks post /api/v2/webhooks get /api/v2/webhooks/{id} patch /api/v2/webhooks/{id} delete /api/v2/webhooks/{id} get /api/v2/webhooks/event-types post /api/v2/webhooks/{id}/test post /api/v2/webhooks/{id}/resume \+ Show [](https://developer.instantly.ai/api/v2/webhookevent) Webhook Event -------------------------------------------------------------------- A webhook event that was sent or attempted to be sent Operations get /api/v2/webhook-events get /api/v2/webhook-events/{id} get /api/v2/webhook-events/summary get /api/v2/webhook-events/summary-by-date \+ Show [](https://developer.instantly.ai/api/v2/dfyemailaccountorder) DFY Email Account Order -------------------------------------------------------------------------------------- A Done-For-You email account order Operations post /api/v2/dfy-email-account-orders get /api/v2/dfy-email-account-orders post /api/v2/dfy-email-account-orders/domains/similar post /api/v2/dfy-email-account-orders/domains/check post /api/v2/dfy-email-account-orders/domains/pre-warmed-up-list get /api/v2/dfy-email-account-orders/accounts post /api/v2/dfy-email-account-orders/accounts/cancel \+ Show [](https://developer.instantly.ai/api/v2/customprompttemplate) Custom Prompt Template ------------------------------------------------------------------------------------- Custom prompt templates for creating custom prompts \+ Show [](https://developer.instantly.ai/api/v2/salesflow) Sales Flow -------------------------------------------------------------- Manages how sales users view and interact with campaign and lead lists within the sales flow. \+ Show [](https://developer.instantly.ai/api/v2/emailtemplate) Email Template ---------------------------------------------------------------------- A campaign email template \+ Show [](https://developer.instantly.ai/api/v2/workspacebilling) Workspace Billing ---------------------------------------------------------------------------- Workspace Billing Operations get /api/v2/workspace-billing/plan-details get /api/v2/workspace-billing/subscription-details \+ Show [](https://developer.instantly.ai/api/v2/crmactions) CRM Actions ---------------------------------------------------------------- CRM related actions Operations get /api/v2/crm-actions/phone-numbers delete /api/v2/crm-actions/phone-numbers/{id} \+ Show [](https://developer.instantly.ai/api/v2/schemas) Schemas --------------------------------------------------------- \+ Show --- # Account [Account](https://developer.instantly.ai/api/v2/account) / Account 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/ [](https://developer.instantly.ai/api/v2/analytics) Analytics ------------------------------------------------------------- Endpoints related to analytics Operations post /api/v2/accounts/warmup-analytics get /api/v2/accounts/analytics/daily post /api/v2/accounts/test/vitals get /api/v2/campaigns/analytics get /api/v2/campaigns/analytics/overview get /api/v2/campaigns/analytics/daily get /api/v2/campaigns/analytics/steps \+ Show [](https://developer.instantly.ai/api/v2/oauth) OAuth ----------------------------------------------------- OAuth authentication endpoints for connecting Google and Microsoft email accounts Operations post /api/v2/oauth/google/init post /api/v2/oauth/microsoft/init get /api/v2/oauth/session/status/{sessionId} \+ Show [](https://developer.instantly.ai/api/v2/account) Account --------------------------------------------------------- An email account that can be used to send campaigns Operations post /api/v2/accounts get /api/v2/accounts get /api/v2/accounts/{email} patch /api/v2/accounts/{email} delete /api/v2/accounts/{email} post /api/v2/accounts/warmup/enable post /api/v2/accounts/warmup/disable post /api/v2/accounts/warmup-analyticsShow 7 more... [](https://developer.instantly.ai/api/v2/account/def-0) Account --------------------------------------------------------------- An email account that can be used to send campaigns [](https://developer.instantly.ai/api/v2/account/def-0#path=email) email_string__(email)_required Email address of the account Example: "user@example.com" [](https://developer.instantly.ai/api/v2/account/def-0#path=timestamp_created) timestamp\_created_string__(date-time)_read-onlyrequired Timestamp when the account was created Example: "2026-02-26T19:34:09.231Z" [](https://developer.instantly.ai/api/v2/account/def-0#path=timestamp_updated) timestamp\_updated_string__(date-time)_read-onlyrequired Timestamp when the account was last updated Example: "2026-02-26T19:34:09.231Z" [](https://developer.instantly.ai/api/v2/account/def-0#path=first_name) first\_name_string_required First name associated with the account Example: "John" [](https://developer.instantly.ai/api/v2/account/def-0#path=last_name) last\_name_string_required Last name associated with the account Example: "Doe" [](https://developer.instantly.ai/api/v2/account/def-0#path=organization) organization_string__(uuid)_read-onlyrequired Organization ID that owns this account Example: "019c9b71-c04f-7265-828a-12ab251a7600" [](https://developer.instantly.ai/api/v2/account/def-0#path=warmup_status) warmup\_status_number_read-onlyrequired Current warmup status of the account | Enum Value | Description | | --- | --- | | 0 | Paused | | 1 | Active | | \-1 | Banned | | \-2 | Spam Folder Unknown | | \-3 | Permanent Suspension | Example: 1 [](https://developer.instantly.ai/api/v2/account/def-0#path=provider_code) provider\_code_number_required Provider code for the account. Please make sure to specify the right provider code, otherwise your account will not work. | Enum Value | Description | | --- | --- | | 1 | Custom IMAP/SMTP | | 2 | Google | | 3 | Microsoft | | 4 | AWS | | 8 | AirMail | Example: 2 [](https://developer.instantly.ai/api/v2/account/def-0#path=setup_pending) setup\_pending_boolean_read-onlyrequired Whether account setup is pending Example: false [](https://developer.instantly.ai/api/v2/account/def-0#path=is_managed_account) is\_managed\_account_boolean_read-onlyrequired Whether this is a managed account Example: false [](https://developer.instantly.ai/api/v2/account/def-0#path=warmup) warmup_object_ Warmup configuration for the account +Show 5 properties [](https://developer.instantly.ai/api/v2/account/def-0#path=added_by) added\_by_null or string__(uuid)_read-only User ID who added the account Example: "019c9b71-c04f-7265-828a-12a956e6c4b2" [](https://developer.instantly.ai/api/v2/account/def-0#path=daily_limit) daily\_limit_null or number_ Daily email sending limit Example: 100 [](https://developer.instantly.ai/api/v2/account/def-0#path=modified_by) modified\_by_null or string__(uuid)_read-only User ID who last modified the account Example: "019c9b71-c04f-7265-828a-12aa51bed589" [](https://developer.instantly.ai/api/v2/account/def-0#path=tracking_domain_name) tracking\_domain\_name_null or string_ Tracking domain Example: "example.com" [](https://developer.instantly.ai/api/v2/account/def-0#path=tracking_domain_status) tracking\_domain\_status_null or string_ Tracking domain status Example: "active" [](https://developer.instantly.ai/api/v2/account/def-0#path=status) status_number_read-only Current status of the account | Enum Value | Description | | --- | --- | | 1 | Active | | 2 | Paused | | 3 | Temporarily paused for maintenance; will be automatically resumed shortly | | \-1 | Connection Error | | \-2 | Soft Bounce Error | | \-3 | Sending Error | Example: 1 [](https://developer.instantly.ai/api/v2/account/def-0#path=enable_slow_ramp) enable\_slow\_ramp_null or boolean_ Whether to enable slow ramp up for sending limits Example: false [](https://developer.instantly.ai/api/v2/account/def-0#path=inbox_placement_test_limit) inbox\_placement\_test\_limit_null or number_ The limit for inbox placement tests Example: 10 [](https://developer.instantly.ai/api/v2/account/def-0#path=timestamp_last_used) timestamp\_last\_used_null or string__(date-time)_read-only Timestamp when the account was last used Example: "2026-02-26T19:34:09.231Z" [](https://developer.instantly.ai/api/v2/account/def-0#path=status_message) status\_message_object_read-only Status message for the account +Show 6 properties [](https://developer.instantly.ai/api/v2/account/def-0#path=timestamp_warmup_start) timestamp\_warmup\_start_null or string__(date-time)_read-only Timestamp when warmup was started Example: "2026-02-26T19:34:09.231Z" [](https://developer.instantly.ai/api/v2/account/def-0#path=warmup_pool_id) warmup\_pool\_id_null or string__(uuid)_read-only ID of the warmup pool this account belongs to Example: "019c9b71-c04f-7265-828a-12acb0282095" [](https://developer.instantly.ai/api/v2/account/def-0#path=dfy_password_changed) dfy\_password\_changed_null or boolean_read-only Whether DFY password has been changed Example: false [](https://developer.instantly.ai/api/v2/account/def-0#path=stat_warmup_score) stat\_warmup\_score_null or number_read-only Warmup score for the account Example: 85 [](https://developer.instantly.ai/api/v2/account/def-0#path=sending_gap) sending\_gap_number__\[ 0 .. 1440 \]_ The gap between emails sent from this account in minutes (minimum wait time when used with multiple campaigns) Example: 10 [](https://developer.instantly.ai/api/v2/account/def-0#path=signature) signature_null or string_ Email signature for the account Example: "Best regards, John Doe" { "email": "user@example.com", "timestamp\_created": "2026-02-26T19:34:09.231Z", "timestamp\_updated": "2026-02-26T19:34:09.231Z", "first\_name": "John", "last\_name": "Doe", "warmup": { "limit": 100, "advanced": { … }, "warmup\_custom\_ftag": "warmup", "increment": "disabled", "reply\_rate": 0.1 }, "added\_by": "019c9b71-c04f-7265-828a-12a956e6c4b2", "daily\_limit": 100, "modified\_by": "019c9b71-c04f-7265-828a-12aa51bed589", "tracking\_domain\_name": "example.com", "tracking\_domain\_status": "active", "status": 1, "enable\_slow\_ramp": false, "inbox\_placement\_test\_limit": 10, "organization": "019c9b71-c04f-7265-828a-12ab251a7600", "timestamp\_last\_used": "2026-02-26T19:34:09.231Z", "warmup\_status": 1, "status\_message": { "code": "EENVELOPE", "command": "DATA", "response": "550-5.4.5 Daily user sending limit exceeded. For more information on Gmai", "e\_message": "error: data command failed: 550-5.4.5 daily user sending limit exceeded", "responseCode": 550 }, "timestamp\_warmup\_start": "2026-02-26T19:34:09.231Z", "provider\_code": 2, "setup\_pending": false, "warmup\_pool\_id": "019c9b71-c04f-7265-828a-12acb0282095", "is\_managed\_account": false, "dfy\_password\_changed": false, "stat\_warmup\_score": 85, "sending\_gap": 10, "signature": "Best regards, John Doe" } [](https://developer.instantly.ai/api/v2/account/createaccount) Create account ------------------------------------------------------------------------------ #### [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/request) RequestExpand all Requires one of the following scopes: `accounts:create`, `accounts:all`, `all:create`, `all:all` Security: ApiKeyAuth [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/request/body) Bodyapplication/jsonrequired The Account to create [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=request&path=email) email_string__(email)_required Email address of the account Example: "user@example.com" [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=request&path=first_name) first\_name_string_required First name associated with the account Example: "John" [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=request&path=last_name) last\_name_string_required Last name associated with the account Example: "Doe" [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=request&path=provider_code) provider\_code_number_required Provider code for the account. Please make sure to specify the right provider code, otherwise your account will not work. | Enum Value | Description | | --- | --- | | 1 | Custom IMAP/SMTP | | 2 | Google | | 3 | Microsoft | | 4 | AWS | | 8 | AirMail | Example: 2 [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=request&path=imap_username) imap\_username_string_required Example: "username" [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=request&path=imap_password) imap\_password_string_required Example: "password" [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=request&path=imap_host) imap\_host_string_required Example: "imap.gmail.com" [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=request&path=imap_port) imap\_port_number_required Example: 993 [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=request&path=smtp_username) smtp\_username_string_required Example: "username" [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=request&path=smtp_password) smtp\_password_string_required Example: "password" [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=request&path=smtp_host) smtp\_host_string_required Example: "smtp.gmail.com" [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=request&path=smtp_port) smtp\_port_number_required Example: 587 [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=request&path=warmup) warmup_object_ Warmup configuration for the account +Show 5 properties [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=request&path=daily_limit) daily\_limit_number or null_ Daily email sending limit Example: 100 [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=request&path=tracking_domain_name) tracking\_domain\_name_string or null_ Tracking domain Example: "example.com" [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=request&path=tracking_domain_status) tracking\_domain\_status_string or null_ Tracking domain status Example: "active" [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=request&path=enable_slow_ramp) enable\_slow\_ramp_boolean or null_ Whether to enable slow ramp up for sending limits Example: false [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=request&path=inbox_placement_test_limit) inbox\_placement\_test\_limit_number or null_ The limit for inbox placement tests Example: 10 [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=request&path=sending_gap) sending\_gap_number__\[ 0 .. 1440 \]_ The gap between emails sent from this account in minutes (minimum wait time when used with multiple campaigns) Example: 10 [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=request&path=signature) signature_string or null_ Email signature for the account Example: "Best regards, John Doe" [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=request&path=reply_to) reply\_to_string_ Example: "reply@example.com" [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=request&path=warmup_custom_ftag) warmup\_custom\_ftag_string_ Example: "warmup" [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=request&path=skip_cname_check) skip\_cname\_check_boolean_ Example: false post /api/v2/accounts * Instantly API Server https://api.instantly.ai/api/v2/accounts * Mock server https://developer.instantly.ai/\_mock/api/v2/api/v2/accounts curl * curl * JavaScript * Node.js * Python * Java * C# * PHP * Go * Ruby * R * Payload curl -i -X POST \\ https://api.instantly.ai/api/v2/accounts \\ -H 'Authorization: Bearer ' \\ -H 'Content-Type: application/json' \\ -d '{ "email": "user@example.com", "first\_name": "John", "last\_name": "Doe", "provider\_code": 2, "imap\_username": "username", "imap\_password": "password", "imap\_host": "imap.gmail.com", "imap\_port": 993, "smtp\_username": "username", "smtp\_password": "password", "smtp\_host": "smtp.gmail.com", "smtp\_port": 587 }' Try it #### [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/response&c=200) Responses 1. 200 2. 400 3. 401 4. 429 Expand all The Account [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/response&c=200/body) Bodyapplication/json [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=response&c=200&path=email) email_string__(email)_required Email address of the account Example: "user@example.com" [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=response&c=200&path=timestamp_created) timestamp\_created_string__(date-time)_read-onlyrequired Timestamp when the account was created Example: "2026-02-26T19:34:09.231Z" [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=response&c=200&path=timestamp_updated) timestamp\_updated_string__(date-time)_read-onlyrequired Timestamp when the account was last updated Example: "2026-02-26T19:34:09.231Z" [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=response&c=200&path=first_name) first\_name_string_required First name associated with the account Example: "John" [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=response&c=200&path=last_name) last\_name_string_required Last name associated with the account Example: "Doe" [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=response&c=200&path=organization) organization_string__(uuid)_read-onlyrequired Organization ID that owns this account Example: "019c9b71-c04f-7265-828a-12ab251a7600" [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=response&c=200&path=warmup_status) warmup\_status_number_read-onlyrequired Current warmup status of the account | Enum Value | Description | | --- | --- | | 0 | Paused | | 1 | Active | | \-1 | Banned | | \-2 | Spam Folder Unknown | | \-3 | Permanent Suspension | Example: 1 [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=response&c=200&path=provider_code) provider\_code_number_required Provider code for the account. Please make sure to specify the right provider code, otherwise your account will not work. | Enum Value | Description | | --- | --- | | 1 | Custom IMAP/SMTP | | 2 | Google | | 3 | Microsoft | | 4 | AWS | | 8 | AirMail | Example: 2 [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=response&c=200&path=setup_pending) setup\_pending_boolean_read-onlyrequired Whether account setup is pending Example: false [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=response&c=200&path=is_managed_account) is\_managed\_account_boolean_read-onlyrequired Whether this is a managed account Example: false [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=response&c=200&path=warmup) warmup_object_ Warmup configuration for the account +Show 5 properties [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=response&c=200&path=added_by) added\_by_null or string__(uuid)_read-only User ID who added the account Example: "019c9b71-c04f-7265-828a-12a956e6c4b2" [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=response&c=200&path=daily_limit) daily\_limit_null or number_ Daily email sending limit Example: 100 [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=response&c=200&path=modified_by) modified\_by_null or string__(uuid)_read-only User ID who last modified the account Example: "019c9b71-c04f-7265-828a-12aa51bed589" [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=response&c=200&path=tracking_domain_name) tracking\_domain\_name_null or string_ Tracking domain Example: "example.com" [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=response&c=200&path=tracking_domain_status) tracking\_domain\_status_null or string_ Tracking domain status Example: "active" [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=response&c=200&path=status) status_number_read-only Current status of the account | Enum Value | Description | | --- | --- | | 1 | Active | | 2 | Paused | | 3 | Temporarily paused for maintenance; will be automatically resumed shortly | | \-1 | Connection Error | | \-2 | Soft Bounce Error | | \-3 | Sending Error | Example: 1 [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=response&c=200&path=enable_slow_ramp) enable\_slow\_ramp_null or boolean_ Whether to enable slow ramp up for sending limits Example: false [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=response&c=200&path=inbox_placement_test_limit) inbox\_placement\_test\_limit_null or number_ The limit for inbox placement tests Example: 10 [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=response&c=200&path=timestamp_last_used) timestamp\_last\_used_null or string__(date-time)_read-only Timestamp when the account was last used Example: "2026-02-26T19:34:09.231Z" [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=response&c=200&path=status_message) status\_message_object_read-only Status message for the account +Show 6 properties [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=response&c=200&path=timestamp_warmup_start) timestamp\_warmup\_start_null or string__(date-time)_read-only Timestamp when warmup was started Example: "2026-02-26T19:34:09.231Z" [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=response&c=200&path=warmup_pool_id) warmup\_pool\_id_null or string__(uuid)_read-only ID of the warmup pool this account belongs to Example: "019c9b71-c04f-7265-828a-12acb0282095" [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=response&c=200&path=dfy_password_changed) dfy\_password\_changed_null or boolean_read-only Whether DFY password has been changed Example: false [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=response&c=200&path=stat_warmup_score) stat\_warmup\_score_null or number_read-only Warmup score for the account Example: 85 [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=response&c=200&path=sending_gap) sending\_gap_number__\[ 0 .. 1440 \]_ The gap between emails sent from this account in minutes (minimum wait time when used with multiple campaigns) Example: 10 [](https://developer.instantly.ai/api/v2/account/createaccount#account/createaccount/t=response&c=200&path=signature) signature_null or string_ Email signature for the account Example: "Best regards, John Doe" Response 1. 200 2. 400 3. 401 4. 429 application/json { "email": "user@example.com", "timestamp\_created": "2026-02-26T19:34:09.231Z", "timestamp\_updated": "2026-02-26T19:34:09.231Z", "first\_name": "John", "last\_name": "Doe", "warmup": { "limit": 100, "advanced": { … }, "warmup\_custom\_ftag": "warmup", "increment": "disabled", "reply\_rate": 0.1 }, "added\_by": "019c9b71-c04f-7265-828a-12a956e6c4b2", "daily\_limit": 100, "modified\_by": "019c9b71-c04f-7265-828a-12aa51bed589", "tracking\_domain\_name": "example.com", "tracking\_domain\_status": "active", "status": 1, "enable\_slow\_ramp": false, "inbox\_placement\_test\_limit": 10, "organization": "019c9b71-c04f-7265-828a-12ab251a7600", "timestamp\_last\_used": "2026-02-26T19:34:09.231Z", "warmup\_status": 1, "status\_message": { "code": "EENVELOPE", "command": "DATA", "response": "550-5.4.5 Daily user sending limit exceeded. For more information on Gmai", "e\_message": "error: data command failed: 550-5.4.5 daily user sending limit exceeded", "responseCode": 550 }, "timestamp\_warmup\_start": "2026-02-26T19:34:09.231Z", "provider\_code": 2, "setup\_pending": false, "warmup\_pool\_id": "019c9b71-c04f-7265-828a-12acb0282095", "is\_managed\_account": false, "dfy\_password\_changed": false, "stat\_warmup\_score": 85, "sending\_gap": 10, "signature": "Best regards, John Doe" } #### Was this helpful? [](https://developer.instantly.ai/api/v2/account/listaccount) List account -------------------------------------------------------------------------- #### [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/request) Request Requires one of the following scopes: `accounts:read`, `accounts:all`, `all:read`, `all:all` Security: ApiKeyAuth [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/request/query) Query [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=request&in=query&path=limit) limit_integer__\[ 1 .. 100 \]_ The number of items to return Example: limit=10 [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=request&in=query&path=starting_after) starting\_after_string__(date-time)_ Example: starting\_after=2026-02-26T19:34:20.878Z [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=request&in=query&path=search) search_string_ Example: search=gmail.com [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=request&in=query&path=status) status_number_ | Enum Value | Description | | --- | --- | | 1 | Active | | 2 | Paused | | 3 | Temporarily paused for maintenance; will be automatically resumed shortly | | \-1 | Connection Error | | \-2 | Soft Bounce Error | | \-3 | Sending Error | Example: status=1 [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=request&in=query&path=provider_code) provider\_code_number_ | Enum Value | Description | | --- | --- | | 1 | Custom IMAP/SMTP | | 2 | Google | | 3 | Microsoft | | 4 | AWS | | 8 | AirMail | Example: provider\_code=2 [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=request&in=query&path=tag_ids) tag\_ids_string_ Filter accounts by tag ids. Returns accounts that have any of the specified tags assigned. You can specify multiple tag ids by separating them with a comma. Example: tag\_ids=019c9b71-edce-7f83-a448-f0ebaefe0f82, 019c9b71-edce-7f83-a448-f0ec307668b5 get /api/v2/accounts * Instantly API Server https://api.instantly.ai/api/v2/accounts * Mock server https://developer.instantly.ai/\_mock/api/v2/api/v2/accounts curl * curl * JavaScript * Node.js * Python * Java * C# * PHP * Go * Ruby * R * Payload curl -i -X GET \\ 'https://api.instantly.ai/api/v2/accounts?limit=10&provider\_code=2&search=gmail.com&starting\_after=2026-02-26T19%3A34%3A20.878Z&status=1&tag\_ids=019c9b71-edce-7f83-a448-f0ebaefe0f82%2C%20019c9b71-edce-7f83-a448-f0ec307668b5' \\ -H 'Authorization: Bearer ' Try it #### [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/response&c=200) Responses 1. 200 2. 401 3. 429 Expand all The list of Account [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/response&c=200/body) Bodyapplication/json [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=response&c=200&path=items) items_Array of objects__(Account)_required The list of Account \- [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=response&c=200&path=items/email) items\[\].​email_string__(email)_required Email address of the account Example: "user@example.com" [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=response&c=200&path=items/timestamp_created) items\[\].​timestamp\_created_string__(date-time)_read-onlyrequired Timestamp when the account was created Example: "2026-02-26T19:34:09.231Z" [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=response&c=200&path=items/timestamp_updated) items\[\].​timestamp\_updated_string__(date-time)_read-onlyrequired Timestamp when the account was last updated Example: "2026-02-26T19:34:09.231Z" [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=response&c=200&path=items/first_name) items\[\].​first\_name_string_required First name associated with the account Example: "John" [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=response&c=200&path=items/last_name) items\[\].​last\_name_string_required Last name associated with the account Example: "Doe" [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=response&c=200&path=items/organization) items\[\].​organization_string__(uuid)_read-onlyrequired Organization ID that owns this account Example: "019c9b71-c04f-7265-828a-12ab251a7600" [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=response&c=200&path=items/warmup_status) items\[\].​warmup\_status_number_read-onlyrequired Current warmup status of the account | Enum Value | Description | | --- | --- | | 0 | Paused | | 1 | Active | | \-1 | Banned | | \-2 | Spam Folder Unknown | | \-3 | Permanent Suspension | Example: 1 [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=response&c=200&path=items/provider_code) items\[\].​provider\_code_number_required Provider code for the account. Please make sure to specify the right provider code, otherwise your account will not work. | Enum Value | Description | | --- | --- | | 1 | Custom IMAP/SMTP | | 2 | Google | | 3 | Microsoft | | 4 | AWS | | 8 | AirMail | Example: 2 [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=response&c=200&path=items/setup_pending) items\[\].​setup\_pending_boolean_read-onlyrequired Whether account setup is pending Example: false [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=response&c=200&path=items/is_managed_account) items\[\].​is\_managed\_account_boolean_read-onlyrequired Whether this is a managed account Example: false [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=response&c=200&path=items/warmup) items\[\].​warmup_object_ Warmup configuration for the account +Show 5 properties [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=response&c=200&path=items/added_by) items\[\].​added\_by_null or string__(uuid)_read-only User ID who added the account Example: "019c9b71-c04f-7265-828a-12a956e6c4b2" [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=response&c=200&path=items/daily_limit) items\[\].​daily\_limit_null or number_ Daily email sending limit Example: 100 [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=response&c=200&path=items/modified_by) items\[\].​modified\_by_null or string__(uuid)_read-only User ID who last modified the account Example: "019c9b71-c04f-7265-828a-12aa51bed589" [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=response&c=200&path=items/tracking_domain_name) items\[\].​tracking\_domain\_name_null or string_ Tracking domain Example: "example.com" [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=response&c=200&path=items/tracking_domain_status) items\[\].​tracking\_domain\_status_null or string_ Tracking domain status Example: "active" [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=response&c=200&path=items/status) items\[\].​status_number_read-only Current status of the account | Enum Value | Description | | --- | --- | | 1 | Active | | 2 | Paused | | 3 | Temporarily paused for maintenance; will be automatically resumed shortly | | \-1 | Connection Error | | \-2 | Soft Bounce Error | | \-3 | Sending Error | Example: 1 [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=response&c=200&path=items/enable_slow_ramp) items\[\].​enable\_slow\_ramp_null or boolean_ Whether to enable slow ramp up for sending limits Example: false [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=response&c=200&path=items/inbox_placement_test_limit) items\[\].​inbox\_placement\_test\_limit_null or number_ The limit for inbox placement tests Example: 10 [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=response&c=200&path=items/timestamp_last_used) items\[\].​timestamp\_last\_used_null or string__(date-time)_read-only Timestamp when the account was last used Example: "2026-02-26T19:34:09.231Z" [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=response&c=200&path=items/status_message) items\[\].​status\_message_object_read-only Status message for the account +Show 6 properties [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=response&c=200&path=items/timestamp_warmup_start) items\[\].​timestamp\_warmup\_start_null or string__(date-time)_read-only Timestamp when warmup was started Example: "2026-02-26T19:34:09.231Z" [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=response&c=200&path=items/warmup_pool_id) items\[\].​warmup\_pool\_id_null or string__(uuid)_read-only ID of the warmup pool this account belongs to Example: "019c9b71-c04f-7265-828a-12acb0282095" [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=response&c=200&path=items/dfy_password_changed) items\[\].​dfy\_password\_changed_null or boolean_read-only Whether DFY password has been changed Example: false [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=response&c=200&path=items/stat_warmup_score) items\[\].​stat\_warmup\_score_null or number_read-only Warmup score for the account Example: 85 [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=response&c=200&path=items/sending_gap) items\[\].​sending\_gap_number__\[ 0 .. 1440 \]_ The gap between emails sent from this account in minutes (minimum wait time when used with multiple campaigns) Example: 10 [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=response&c=200&path=items/signature) items\[\].​signature_null or string_ Email signature for the account Example: "Best regards, John Doe" [](https://developer.instantly.ai/api/v2/account/listaccount#account/listaccount/t=response&c=200&path=next_starting_after) next\_starting\_after_string_ The filter for getting the next items after this one, this could either be a UUID, a timestamp, on an email depending on the specific API Example: "019c9b71-edce-7f83-a448-f0ed04680b33" Response 1. 200 2. 401 3. 429 application/json { "items": \[\ { … }\ \], "next\_starting\_after": "019c9b71-edce-7f83-a448-f0ed04680b33" } #### Was this helpful? [](https://developer.instantly.ai/api/v2/campaign) Campaign ----------------------------------------------------------- A campaign that can be sent to a list of recipients Operations post /api/v2/campaigns get /api/v2/campaigns post /api/v2/campaigns/{id}/activate post /api/v2/campaigns/{id}/pause get /api/v2/campaigns/{id} patch /api/v2/campaigns/{id} delete /api/v2/campaigns/{id} get /api/v2/campaigns/search-by-contactShow 11 more... \+ Show [](https://developer.instantly.ai/api/v2/email) Email ----------------------------------------------------- A campaign email, a reply, a manually sent email, or any other email that's visible in the Unibox Operations post /api/v2/emails/reply post /api/v2/emails/forward get /api/v2/emails get /api/v2/emails/{id} patch /api/v2/emails/{id} delete /api/v2/emails/{id} get /api/v2/emails/unread/count post /api/v2/emails/threads/{thread\_id}/mark-as-read \+ Show [](https://developer.instantly.ai/api/v2/emailverification) Email Verification ------------------------------------------------------------------------------ A single email verification Operations post /api/v2/email-verification get /api/v2/email-verification/{email} \+ Show [](https://developer.instantly.ai/api/v2/leadlist) Lead List ------------------------------------------------------------ A list used to store leads Operations post /api/v2/lead-lists get /api/v2/lead-lists get /api/v2/lead-lists/{id} patch /api/v2/lead-lists/{id} delete /api/v2/lead-lists/{id} get /api/v2/lead-lists/{id}/verification-stats \+ Show [](https://developer.instantly.ai/api/v2/inboxplacementtest) Inbox Placement Test --------------------------------------------------------------------------------- An inbox placement test Operations post /api/v2/inbox-placement-tests get /api/v2/inbox-placement-tests get /api/v2/inbox-placement-tests/{id} delete /api/v2/inbox-placement-tests/{id} patch /api/v2/inbox-placement-tests/{id} get /api/v2/inbox-placement-tests/email-service-provider-options \+ Show [](https://developer.instantly.ai/api/v2/inboxplacementanalytics) Inbox Placement Analytics ------------------------------------------------------------------------------------------- Analytics data for individual emails in inbox placement tests Operations get /api/v2/inbox-placement-analytics get /api/v2/inbox-placement-analytics/{id} post /api/v2/inbox-placement-analytics/stats-by-test-id post /api/v2/inbox-placement-analytics/deliverability-insights post /api/v2/inbox-placement-analytics/stats-by-date \+ Show [](https://developer.instantly.ai/api/v2/inboxplacementblacklistandspamassassinreport) Inbox Placement Blacklist & SpamAssassin Report -------------------------------------------------------------------------------------------------------------------------------------- Report data for an inbox placement test Operations get /api/v2/inbox-placement-reports get /api/v2/inbox-placement-reports/{id} \+ Show [](https://developer.instantly.ai/api/v2/apikey) API Key -------------------------------------------------------- API Key Operations post /api/v2/api-keys get /api/v2/api-keys delete /api/v2/api-keys/{id} \+ Show [](https://developer.instantly.ai/api/v2/accountcampaignmapping) Account Campaign Mapping ----------------------------------------------------------------------------------------- Account Campaign Mapping Operations get /api/v2/account-campaign-mappings/{email} \+ Show [](https://developer.instantly.ai/api/v2/lead) Lead --------------------------------------------------- A lead entity representing an individual lead Operations post /api/v2/leads delete /api/v2/leads post /api/v2/leads/list get /api/v2/leads/{id} patch /api/v2/leads/{id} delete /api/v2/leads/{id} post /api/v2/leads/merge post /api/v2/leads/update-interest-statusShow 5 more... \+ Show [](https://developer.instantly.ai/api/v2/backgroundjob) Background Job ---------------------------------------------------------------------- A background job that can be used to perform long-running tasks Operations get /api/v2/background-jobs get /api/v2/background-jobs/{id} \+ Show [](https://developer.instantly.ai/api/v2/customtag) Custom Tag -------------------------------------------------------------- A custom tag for organizing and categorizing accounts and campaigns. You can use them as filters in apis that list accounts and campaigns. Operations post /api/v2/custom-tags get /api/v2/custom-tags get /api/v2/custom-tags/{id} patch /api/v2/custom-tags/{id} delete /api/v2/custom-tags/{id} post /api/v2/custom-tags/toggle-resource \+ Show [](https://developer.instantly.ai/api/v2/customtagmapping) Custom Tag Mapping ----------------------------------------------------------------------------- This entity represents a tag being assigned to a specific campaign or email account. When an email account is assigned a tag, a new custom tag mapping entry is created, which connects the tag (`tag_id` field) with the email account (`resource_id` field). You can use it to see which tag si connected to which resource. Operations get /api/v2/custom-tag-mappings \+ Show [](https://developer.instantly.ai/api/v2/blocklistentry) Block List Entry ------------------------------------------------------------------------- A blocked email or domain Operations post /api/v2/block-lists-entries get /api/v2/block-lists-entries get /api/v2/block-lists-entries/{id} patch /api/v2/block-lists-entries/{id} delete /api/v2/block-lists-entries/{id} \+ Show [](https://developer.instantly.ai/api/v2/leadlabel) Lead Label -------------------------------------------------------------- A custom label for categorizing and managing leads Operations post /api/v2/lead-labels get /api/v2/lead-labels get /api/v2/lead-labels/{id} patch /api/v2/lead-labels/{id} delete /api/v2/lead-labels/{id} post /api/v2/lead-labels/ai-reply-label \+ Show [](https://developer.instantly.ai/api/v2/workspace) Workspace ------------------------------------------------------------- A workspace entity representing a workspace Operations get /api/v2/workspaces/current patch /api/v2/workspaces/current post /api/v2/workspaces/current/whitelabel-domain get /api/v2/workspaces/current/whitelabel-domain delete /api/v2/workspaces/current/whitelabel-domain post /api/v2/workspaces/current/change-owner \+ Show [](https://developer.instantly.ai/api/v2/supersearchenrichment) SuperSearch Enrichment -------------------------------------------------------------------------------------- An enrichment can take different forms, such as email enrichment or LinkedIn enrichment. Leads may be imported from SuperSearch using the dedicated endpoint, or enriched directly within a list or campaign by attaching an enrichment to it. Operations post /api/v2/supersearch-enrichment/enrich-leads-from-supersearch get /api/v2/supersearch-enrichment/{resource\_id} post /api/v2/supersearch-enrichment patch /api/v2/supersearch-enrichment/{resource\_id}/settings post /api/v2/supersearch-enrichment/ai get /api/v2/supersearch-enrichment/ai/{resource\_id}/in-progress get /api/v2/supersearch-enrichment/history/{resource\_id} post /api/v2/supersearch-enrichment/runShow 2 more... \+ Show [](https://developer.instantly.ai/api/v2/workspacegroupmember) 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 post /api/v2/workspace-group-members get /api/v2/workspace-group-members get /api/v2/workspace-group-members/{id} delete /api/v2/workspace-group-members/{id} get /api/v2/workspace-group-members/admin \+ Show [](https://developer.instantly.ai/api/v2/workspacemember) Workspace Member -------------------------------------------------------------------------- A member of a workspace with associated user details Operations post /api/v2/workspace-members get /api/v2/workspace-members get /api/v2/workspace-members/{id} patch /api/v2/workspace-members/{id} delete /api/v2/workspace-members/{id} \+ Show [](https://developer.instantly.ai/api/v2/campaignsubsequence) Campaign Subsequence ---------------------------------------------------------------------------------- A subsequence entity representing a follow-up sequence Operations post /api/v2/subsequences get /api/v2/subsequences post /api/v2/subsequences/{id}/duplicate post /api/v2/subsequences/{id}/pause post /api/v2/subsequences/{id}/resume get /api/v2/subsequences/{id} patch /api/v2/subsequences/{id} delete /api/v2/subsequences/{id}Show 1 more... \+ Show [](https://developer.instantly.ai/api/v2/auditlog) Audit Log ------------------------------------------------------------ Audit log records for tracking system activities Operations get /api/v2/audit-logs \+ Show [](https://developer.instantly.ai/api/v2/webhook) Webhook --------------------------------------------------------- A webhook subscription for receiving event notifications Operations get /api/v2/webhooks post /api/v2/webhooks get /api/v2/webhooks/{id} patch /api/v2/webhooks/{id} delete /api/v2/webhooks/{id} get /api/v2/webhooks/event-types post /api/v2/webhooks/{id}/test post /api/v2/webhooks/{id}/resume \+ Show [](https://developer.instantly.ai/api/v2/webhookevent) Webhook Event -------------------------------------------------------------------- A webhook event that was sent or attempted to be sent Operations get /api/v2/webhook-events get /api/v2/webhook-events/{id} get /api/v2/webhook-events/summary get /api/v2/webhook-events/summary-by-date \+ Show [](https://developer.instantly.ai/api/v2/dfyemailaccountorder) DFY Email Account Order -------------------------------------------------------------------------------------- A Done-For-You email account order Operations post /api/v2/dfy-email-account-orders get /api/v2/dfy-email-account-orders post /api/v2/dfy-email-account-orders/domains/similar post /api/v2/dfy-email-account-orders/domains/check post /api/v2/dfy-email-account-orders/domains/pre-warmed-up-list get /api/v2/dfy-email-account-orders/accounts post /api/v2/dfy-email-account-orders/accounts/cancel \+ Show [](https://developer.instantly.ai/api/v2/customprompttemplate) Custom Prompt Template ------------------------------------------------------------------------------------- Custom prompt templates for creating custom prompts \+ Show [](https://developer.instantly.ai/api/v2/salesflow) Sales Flow -------------------------------------------------------------- Manages how sales users view and interact with campaign and lead lists within the sales flow. \+ Show [](https://developer.instantly.ai/api/v2/emailtemplate) Email Template ---------------------------------------------------------------------- A campaign email template \+ Show [](https://developer.instantly.ai/api/v2/workspacebilling) Workspace Billing ---------------------------------------------------------------------------- Workspace Billing Operations get /api/v2/workspace-billing/plan-details get /api/v2/workspace-billing/subscription-details \+ Show [](https://developer.instantly.ai/api/v2/crmactions) CRM Actions ---------------------------------------------------------------- CRM related actions Operations get /api/v2/crm-actions/phone-numbers delete /api/v2/crm-actions/phone-numbers/{id} \+ Show [](https://developer.instantly.ai/api/v2/schemas) Schemas --------------------------------------------------------- \+ Show --- # Initialize microsoft oauth [OAuth](https://developer.instantly.ai/api/v2/oauth) / Initialize microsoft oauth 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/ [](https://developer.instantly.ai/api/v2/analytics) Analytics ------------------------------------------------------------- Endpoints related to analytics Operations post /api/v2/accounts/warmup-analytics get /api/v2/accounts/analytics/daily post /api/v2/accounts/test/vitals get /api/v2/campaigns/analytics get /api/v2/campaigns/analytics/overview get /api/v2/campaigns/analytics/daily get /api/v2/campaigns/analytics/steps \+ Show [](https://developer.instantly.ai/api/v2/oauth) OAuth ----------------------------------------------------- OAuth authentication endpoints for connecting Google and Microsoft email accounts Operations post /api/v2/oauth/google/init post /api/v2/oauth/microsoft/init get /api/v2/oauth/session/status/{sessionId} [](https://developer.instantly.ai/api/v2/oauth/initgoogleoauth) Initialize google oauth --------------------------------------------------------------------------------------- #### [](https://developer.instantly.ai/api/v2/oauth/initgoogleoauth#oauth/initgoogleoauth/request) Request Creates an OAuth session and returns the Google authorization URL. The user should be redirected to auth\_url to complete the OAuth flow. Poll the status endpoint to check for completion. Security: ApiKeyAuth post /api/v2/oauth/google/init * Instantly API Server https://api.instantly.ai/api/v2/oauth/google/init * Mock server https://developer.instantly.ai/\_mock/api/v2/api/v2/oauth/google/init curl * curl * JavaScript * Node.js * Python * Java * C# * PHP * Go * Ruby * R * Payload curl -i -X POST \\ https://api.instantly.ai/api/v2/oauth/google/init \\ -H 'Authorization: Bearer ' Try it #### [](https://developer.instantly.ai/api/v2/oauth/initgoogleoauth#oauth/initgoogleoauth/response&c=200) Responses 1. 200 Default Response [](https://developer.instantly.ai/api/v2/oauth/initgoogleoauth#oauth/initgoogleoauth/response&c=200/body) Bodyapplication/json [](https://developer.instantly.ai/api/v2/oauth/initgoogleoauth#oauth/initgoogleoauth/t=response&c=200&path=session_id) session\_id_string_ Session ID for polling status Example: "abc123def456" [](https://developer.instantly.ai/api/v2/oauth/initgoogleoauth#oauth/initgoogleoauth/t=response&c=200&path=auth_url) auth\_url_string_ Google authorization URL to redirect user to Example: "https://accounts.google.com/o/oauth2/auth?..." [](https://developer.instantly.ai/api/v2/oauth/initgoogleoauth#oauth/initgoogleoauth/t=response&c=200&path=expires_at) expires\_at_string__(date-time)_ Session expiry time (10 minutes from creation) Example: "2026-01-14T12:30:00.000Z" Response 1. 200 application/json { "session\_id": "abc123def456", "auth\_url": "https://accounts.google.com/o/oauth2/auth?...", "expires\_at": "2026-01-14T12:30:00.000Z" } #### Was this helpful? [](https://developer.instantly.ai/api/v2/oauth/initmicrosoftoauth) Initialize microsoft oauth --------------------------------------------------------------------------------------------- #### [](https://developer.instantly.ai/api/v2/oauth/initmicrosoftoauth#oauth/initmicrosoftoauth/request) Request Creates an OAuth session and returns the Microsoft authorization URL. The user should be redirected to auth\_url to complete the OAuth flow. Poll the status endpoint to check for completion. Security: ApiKeyAuth post /api/v2/oauth/microsoft/init * Instantly API Server https://api.instantly.ai/api/v2/oauth/microsoft/init * Mock server https://developer.instantly.ai/\_mock/api/v2/api/v2/oauth/microsoft/init curl * curl * JavaScript * Node.js * Python * Java * C# * PHP * Go * Ruby * R * Payload curl -i -X POST \\ https://api.instantly.ai/api/v2/oauth/microsoft/init \\ -H 'Authorization: Bearer ' Try it #### [](https://developer.instantly.ai/api/v2/oauth/initmicrosoftoauth#oauth/initmicrosoftoauth/response&c=200) Responses 1. 200 Default Response [](https://developer.instantly.ai/api/v2/oauth/initmicrosoftoauth#oauth/initmicrosoftoauth/response&c=200/body) Bodyapplication/json [](https://developer.instantly.ai/api/v2/oauth/initmicrosoftoauth#oauth/initmicrosoftoauth/t=response&c=200&path=session_id) session\_id_string_ Session ID for polling status Example: "abc123def456" [](https://developer.instantly.ai/api/v2/oauth/initmicrosoftoauth#oauth/initmicrosoftoauth/t=response&c=200&path=auth_url) auth\_url_string_ Microsoft authorization URL to redirect user to Example: "https://login.microsoftonline.com/common/oauth2/v2.0/authorize?..." [](https://developer.instantly.ai/api/v2/oauth/initmicrosoftoauth#oauth/initmicrosoftoauth/t=response&c=200&path=expires_at) expires\_at_string__(date-time)_ Session expiry time (10 minutes from creation) Example: "2026-01-14T12:30:00.000Z" Response 1. 200 application/json { "session\_id": "abc123def456", "auth\_url": "https://login.microsoftonline.com/common/oauth2/v2.0/authorize?...", "expires\_at": "2026-01-14T12:30:00.000Z" } #### Was this helpful? [](https://developer.instantly.ai/api/v2/oauth/getoauthsessionstatus) Get oauth session status ---------------------------------------------------------------------------------------------- #### [](https://developer.instantly.ai/api/v2/oauth/getoauthsessionstatus#oauth/getoauthsessionstatus/request) Request Poll this endpoint to check the OAuth session result. Works for both Google and Microsoft OAuth sessions. Returns pending while waiting, success with account details when complete, or error if something went wrong. Sessions expire after 10 minutes. Security: ApiKeyAuth [](https://developer.instantly.ai/api/v2/oauth/getoauthsessionstatus#oauth/getoauthsessionstatus/request/path) Path [](https://developer.instantly.ai/api/v2/oauth/getoauthsessionstatus#oauth/getoauthsessionstatus/t=request&in=path&path=sessionid) sessionId_string_required Session ID from init response Example: abc123def456 get /api/v2/oauth/session/status/{sessionId} * Instantly API Server https://api.instantly.ai/api/v2/oauth/session/status/{sessionId} * Mock server https://developer.instantly.ai/\_mock/api/v2/api/v2/oauth/session/status/{sessionId} curl * curl * JavaScript * Node.js * Python * Java * C# * PHP * Go * Ruby * R * Payload curl -i -X GET \\ https://api.instantly.ai/api/v2/oauth/session/status/abc123def456 \\ -H 'Authorization: Bearer ' Try it #### [](https://developer.instantly.ai/api/v2/oauth/getoauthsessionstatus#oauth/getoauthsessionstatus/response&c=200) Responses 1. 200 Default Response [](https://developer.instantly.ai/api/v2/oauth/getoauthsessionstatus#oauth/getoauthsessionstatus/response&c=200/body) Bodyapplication/json [](https://developer.instantly.ai/api/v2/oauth/getoauthsessionstatus#oauth/getoauthsessionstatus/t=response&c=200&path=status) status_string_ Current status of the OAuth session Enum"pending""success""error""expired" Example: "success" [](https://developer.instantly.ai/api/v2/oauth/getoauthsessionstatus#oauth/getoauthsessionstatus/t=response&c=200&path=email) email_string_ Email of the connected account (on success) Example: "user@example.com" [](https://developer.instantly.ai/api/v2/oauth/getoauthsessionstatus#oauth/getoauthsessionstatus/t=response&c=200&path=name) name_string_ Name of the account owner (on success) Example: "John Doe" [](https://developer.instantly.ai/api/v2/oauth/getoauthsessionstatus#oauth/getoauthsessionstatus/t=response&c=200&path=error) error_string_ Error code (on error) Example: "access\_denied" [](https://developer.instantly.ai/api/v2/oauth/getoauthsessionstatus#oauth/getoauthsessionstatus/t=response&c=200&path=error_description) error\_description_string_ Human-readable error description (on error) Example: "User denied access to the application" Response 1. 200 application/json { "status": "success", "email": "user@example.com", "name": "John Doe", "error": "access\_denied", "error\_description": "User denied access to the application" } #### Was this helpful? [](https://developer.instantly.ai/api/v2/account) Account --------------------------------------------------------- An email account that can be used to send campaigns Operations post /api/v2/accounts get /api/v2/accounts get /api/v2/accounts/{email} patch /api/v2/accounts/{email} delete /api/v2/accounts/{email} post /api/v2/accounts/warmup/enable post /api/v2/accounts/warmup/disable post /api/v2/accounts/warmup-analyticsShow 7 more... \+ Show [](https://developer.instantly.ai/api/v2/campaign) Campaign ----------------------------------------------------------- A campaign that can be sent to a list of recipients Operations post /api/v2/campaigns get /api/v2/campaigns post /api/v2/campaigns/{id}/activate post /api/v2/campaigns/{id}/pause get /api/v2/campaigns/{id} patch /api/v2/campaigns/{id} delete /api/v2/campaigns/{id} get /api/v2/campaigns/search-by-contactShow 11 more... \+ Show [](https://developer.instantly.ai/api/v2/email) Email ----------------------------------------------------- A campaign email, a reply, a manually sent email, or any other email that's visible in the Unibox Operations post /api/v2/emails/reply post /api/v2/emails/forward get /api/v2/emails get /api/v2/emails/{id} patch /api/v2/emails/{id} delete /api/v2/emails/{id} get /api/v2/emails/unread/count post /api/v2/emails/threads/{thread\_id}/mark-as-read \+ Show [](https://developer.instantly.ai/api/v2/emailverification) Email Verification ------------------------------------------------------------------------------ A single email verification Operations post /api/v2/email-verification get /api/v2/email-verification/{email} \+ Show [](https://developer.instantly.ai/api/v2/leadlist) Lead List ------------------------------------------------------------ A list used to store leads Operations post /api/v2/lead-lists get /api/v2/lead-lists get /api/v2/lead-lists/{id} patch /api/v2/lead-lists/{id} delete /api/v2/lead-lists/{id} get /api/v2/lead-lists/{id}/verification-stats \+ Show [](https://developer.instantly.ai/api/v2/inboxplacementtest) Inbox Placement Test --------------------------------------------------------------------------------- An inbox placement test Operations post /api/v2/inbox-placement-tests get /api/v2/inbox-placement-tests get /api/v2/inbox-placement-tests/{id} delete /api/v2/inbox-placement-tests/{id} patch /api/v2/inbox-placement-tests/{id} get /api/v2/inbox-placement-tests/email-service-provider-options \+ Show [](https://developer.instantly.ai/api/v2/inboxplacementanalytics) Inbox Placement Analytics ------------------------------------------------------------------------------------------- Analytics data for individual emails in inbox placement tests Operations get /api/v2/inbox-placement-analytics get /api/v2/inbox-placement-analytics/{id} post /api/v2/inbox-placement-analytics/stats-by-test-id post /api/v2/inbox-placement-analytics/deliverability-insights post /api/v2/inbox-placement-analytics/stats-by-date \+ Show [](https://developer.instantly.ai/api/v2/inboxplacementblacklistandspamassassinreport) Inbox Placement Blacklist & SpamAssassin Report -------------------------------------------------------------------------------------------------------------------------------------- Report data for an inbox placement test Operations get /api/v2/inbox-placement-reports get /api/v2/inbox-placement-reports/{id} \+ Show [](https://developer.instantly.ai/api/v2/apikey) API Key -------------------------------------------------------- API Key Operations post /api/v2/api-keys get /api/v2/api-keys delete /api/v2/api-keys/{id} \+ Show [](https://developer.instantly.ai/api/v2/accountcampaignmapping) Account Campaign Mapping ----------------------------------------------------------------------------------------- Account Campaign Mapping Operations get /api/v2/account-campaign-mappings/{email} \+ Show [](https://developer.instantly.ai/api/v2/lead) Lead --------------------------------------------------- A lead entity representing an individual lead Operations post /api/v2/leads delete /api/v2/leads post /api/v2/leads/list get /api/v2/leads/{id} patch /api/v2/leads/{id} delete /api/v2/leads/{id} post /api/v2/leads/merge post /api/v2/leads/update-interest-statusShow 5 more... \+ Show [](https://developer.instantly.ai/api/v2/backgroundjob) Background Job ---------------------------------------------------------------------- A background job that can be used to perform long-running tasks Operations get /api/v2/background-jobs get /api/v2/background-jobs/{id} \+ Show [](https://developer.instantly.ai/api/v2/customtag) Custom Tag -------------------------------------------------------------- A custom tag for organizing and categorizing accounts and campaigns. You can use them as filters in apis that list accounts and campaigns. Operations post /api/v2/custom-tags get /api/v2/custom-tags get /api/v2/custom-tags/{id} patch /api/v2/custom-tags/{id} delete /api/v2/custom-tags/{id} post /api/v2/custom-tags/toggle-resource \+ Show [](https://developer.instantly.ai/api/v2/customtagmapping) Custom Tag Mapping ----------------------------------------------------------------------------- This entity represents a tag being assigned to a specific campaign or email account. When an email account is assigned a tag, a new custom tag mapping entry is created, which connects the tag (`tag_id` field) with the email account (`resource_id` field). You can use it to see which tag si connected to which resource. Operations get /api/v2/custom-tag-mappings \+ Show [](https://developer.instantly.ai/api/v2/blocklistentry) Block List Entry ------------------------------------------------------------------------- A blocked email or domain Operations post /api/v2/block-lists-entries get /api/v2/block-lists-entries get /api/v2/block-lists-entries/{id} patch /api/v2/block-lists-entries/{id} delete /api/v2/block-lists-entries/{id} \+ Show [](https://developer.instantly.ai/api/v2/leadlabel) Lead Label -------------------------------------------------------------- A custom label for categorizing and managing leads Operations post /api/v2/lead-labels get /api/v2/lead-labels get /api/v2/lead-labels/{id} patch /api/v2/lead-labels/{id} delete /api/v2/lead-labels/{id} post /api/v2/lead-labels/ai-reply-label \+ Show [](https://developer.instantly.ai/api/v2/workspace) Workspace ------------------------------------------------------------- A workspace entity representing a workspace Operations get /api/v2/workspaces/current patch /api/v2/workspaces/current post /api/v2/workspaces/current/whitelabel-domain get /api/v2/workspaces/current/whitelabel-domain delete /api/v2/workspaces/current/whitelabel-domain post /api/v2/workspaces/current/change-owner \+ Show [](https://developer.instantly.ai/api/v2/supersearchenrichment) SuperSearch Enrichment -------------------------------------------------------------------------------------- An enrichment can take different forms, such as email enrichment or LinkedIn enrichment. Leads may be imported from SuperSearch using the dedicated endpoint, or enriched directly within a list or campaign by attaching an enrichment to it. Operations post /api/v2/supersearch-enrichment/enrich-leads-from-supersearch get /api/v2/supersearch-enrichment/{resource\_id} post /api/v2/supersearch-enrichment patch /api/v2/supersearch-enrichment/{resource\_id}/settings post /api/v2/supersearch-enrichment/ai get /api/v2/supersearch-enrichment/ai/{resource\_id}/in-progress get /api/v2/supersearch-enrichment/history/{resource\_id} post /api/v2/supersearch-enrichment/runShow 2 more... \+ Show [](https://developer.instantly.ai/api/v2/workspacegroupmember) 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 post /api/v2/workspace-group-members get /api/v2/workspace-group-members get /api/v2/workspace-group-members/{id} delete /api/v2/workspace-group-members/{id} get /api/v2/workspace-group-members/admin \+ Show [](https://developer.instantly.ai/api/v2/workspacemember) Workspace Member -------------------------------------------------------------------------- A member of a workspace with associated user details Operations post /api/v2/workspace-members get /api/v2/workspace-members get /api/v2/workspace-members/{id} patch /api/v2/workspace-members/{id} delete /api/v2/workspace-members/{id} \+ Show [](https://developer.instantly.ai/api/v2/campaignsubsequence) Campaign Subsequence ---------------------------------------------------------------------------------- A subsequence entity representing a follow-up sequence Operations post /api/v2/subsequences get /api/v2/subsequences post /api/v2/subsequences/{id}/duplicate post /api/v2/subsequences/{id}/pause post /api/v2/subsequences/{id}/resume get /api/v2/subsequences/{id} patch /api/v2/subsequences/{id} delete /api/v2/subsequences/{id}Show 1 more... \+ Show [](https://developer.instantly.ai/api/v2/auditlog) Audit Log ------------------------------------------------------------ Audit log records for tracking system activities Operations get /api/v2/audit-logs \+ Show [](https://developer.instantly.ai/api/v2/webhook) Webhook --------------------------------------------------------- A webhook subscription for receiving event notifications Operations get /api/v2/webhooks post /api/v2/webhooks get /api/v2/webhooks/{id} patch /api/v2/webhooks/{id} delete /api/v2/webhooks/{id} get /api/v2/webhooks/event-types post /api/v2/webhooks/{id}/test post /api/v2/webhooks/{id}/resume \+ Show [](https://developer.instantly.ai/api/v2/webhookevent) Webhook Event -------------------------------------------------------------------- A webhook event that was sent or attempted to be sent Operations get /api/v2/webhook-events get /api/v2/webhook-events/{id} get /api/v2/webhook-events/summary get /api/v2/webhook-events/summary-by-date \+ Show [](https://developer.instantly.ai/api/v2/dfyemailaccountorder) DFY Email Account Order -------------------------------------------------------------------------------------- A Done-For-You email account order Operations post /api/v2/dfy-email-account-orders get /api/v2/dfy-email-account-orders post /api/v2/dfy-email-account-orders/domains/similar post /api/v2/dfy-email-account-orders/domains/check post /api/v2/dfy-email-account-orders/domains/pre-warmed-up-list get /api/v2/dfy-email-account-orders/accounts post /api/v2/dfy-email-account-orders/accounts/cancel \+ Show [](https://developer.instantly.ai/api/v2/customprompttemplate) Custom Prompt Template ------------------------------------------------------------------------------------- Custom prompt templates for creating custom prompts \+ Show [](https://developer.instantly.ai/api/v2/salesflow) Sales Flow -------------------------------------------------------------- Manages how sales users view and interact with campaign and lead lists within the sales flow. \+ Show [](https://developer.instantly.ai/api/v2/emailtemplate) Email Template ---------------------------------------------------------------------- A campaign email template \+ Show [](https://developer.instantly.ai/api/v2/workspacebilling) Workspace Billing ---------------------------------------------------------------------------- Workspace Billing Operations get /api/v2/workspace-billing/plan-details get /api/v2/workspace-billing/subscription-details \+ Show [](https://developer.instantly.ai/api/v2/crmactions) CRM Actions ---------------------------------------------------------------- CRM related actions Operations get /api/v2/crm-actions/phone-numbers delete /api/v2/crm-actions/phone-numbers/{id} \+ Show [](https://developer.instantly.ai/api/v2/schemas) Schemas --------------------------------------------------------- \+ Show ---