{"id":36089,"date":"2024-12-19T16:37:33","date_gmt":"2024-12-19T13:37:33","guid":{"rendered":"https:\/\/snov.io\/knowledgebase\/?p=36089"},"modified":"2025-02-23T18:08:01","modified_gmt":"2025-02-23T15:08:01","slug":"how-to-get-campaign-analytics-via-api","status":"publish","type":"post","link":"https:\/\/snov.io\/knowledgebase\/how-to-get-campaign-analytics-via-api\/","title":{"rendered":"How to get campaign analytics via API"},"content":{"rendered":"

Learn how to retrieve statistical data from your Snov.io account using API requests.<\/span><\/p>\n

This guide explains two requests: <\/span><\/p>\n

Get campaign analytics<\/b><\/a><\/p>\n

View campaign progress<\/b><\/a><\/p>\n

Let\u2019s review their use cases and main parameters.<\/span><\/p>\n

Get campaign analytics<\/strong><\/h2>\n
\n
\n

Before making any API request, get \"access_token\" using the authentication request: https:\/\/api.snov.io\/v1\/oauth\/access_token<\/a>.<\/p>\n<\/div>\n<\/div>\n

Request\u2019s type: <\/b>GET<\/span><\/p>\n

Request\u2019s URL: <\/b>https:\/\/api.snov.io\/v2\/statistics\/campaign-analytics<\/span><\/a><\/p>\n

Link to API documentation.<\/a><\/p>\n

This request provides detailed analytics for your Snov.io campaigns. Use it to retrieve data on overall campaign's sucess or filter results by campaigns, senders, team members, or time periods.<\/p>\n

It also can help you generate reports automatically with data from your account and integrate your Snov.io KPIs into your reporting process.<\/p>\n

Request\u2019s parameters<\/b><\/h3>\n

All parameters in this request are optional. If no parameters are provided, the request will return all-time statistics for all campaigns and accounts.<\/span><\/p>\n

To filter data in response, apply relevant filters in request's parameters. <\/span>See full parameters list in API documentation<\/a>.<\/span><\/p>\n

For example, use the <\/span>\"campaign_id\"<\/b> field in the request parameters to specify the IDs of the campaigns you want to retrieve statistics for. Add IDs for specific or multiple campaigns (separated by comma).<\/span><\/p>\n

\n
\n

To find a campaign ID, open the relevant campaign in your campaigns list. The campaign ID is the number at the end of the URL in your browser's address bar. (Example: in the campaign URL: https:\/\/app.snov.io\/campaigns\/2402609<\/a>, the ID is \"2402609\").<\/p>\n<\/div>\n<\/div>\n

To retrieve data for specific team members, use the <\/span>\"campaign_owner\"<\/b> field. Enter the email addresses the team members use to join the team in Snov.io. <\/span><\/p>\n

\n
\"learn\"<\/div>\n
\n

Find team members' emails on the My Team<\/a> page. \"Campaign owner\" filter is available if you are a team leader in Snov.io or have the \"View team records\" permission enabled.<\/p>\n<\/div>\n<\/div>\n

Request\u2019s result<\/b><\/h3>\n

The response includes all default metrics from your outreach in Snov.io, covering email and <\/span>LinkedIn automation<\/span><\/a> statistics.<\/span><\/p>\n

\n
\"learn\"<\/div>\n
\n

The data for each metric returned in the results depends on the applied filters. If it contains zero (0) values, it means no data is available based on the request parameters. Adjust your request to access more campaign data.<\/p>\n<\/div>\n<\/div>\n

General data fields (email + LinkedIn):<\/strong><\/p>\n

\"total_contacted\";<\/pre>\n
Email data fields:<\/strong><\/p>\n
\"contacted_by_email\";\"emails_sent\";\"first_emails\";\"follow_ups\";\"delivered\";\"bounced\";\"email_opens\";\"link_clicks\";\"email_replies\";\"unsubscribed\";\"auto_replied\".<\/pre>\n
LinkedIn data fields:<\/strong><\/p>\n
\"contacted_by_linkedin\";\"linkedin_total_replies\";\"linkedin_total_replies_rate\";\"connection_request_replies\";\"message_replies\";\"connection_requests\";\"accepted_requests\";\r\n\"failed_connection_requests\";\"messages_sent\";\"linkedin_views\";\"linkedin_likes\";\"linkedin_follows\".<\/pre>\n
See full list of fields provided in the API response<\/a>.<\/span>\u00a0The visual representation of this data can be found on the Reports dashboard<\/a> in the Snov.io app.<\/span><\/p>\n
View campaign progress<\/strong><\/h2>\n
\n
\n
Before making any API request, get \"access_token\" using the authentication request: https:\/\/api.snov.io\/v1\/oauth\/access_token<\/a>.<\/p>\n<\/div>\n<\/div>\n
Request\u2019s type: <\/b>GET<\/span><\/p>\n
Request\u2019s URL: <\/b>https:\/\/api.snov.io\/v2\/campaigns\/[campaign_id]\/progress<\/span><\/a><\/p>\n
Link to API documentation.<\/a><\/p>\n
Use this request to get data on how many recipients have completed the campaign, how many are still in progress, and how many have stopped due to specific reasons. This helps you track campaign progress and make adjustments as necessary.<\/p>\n
Request\u2019s parameters<\/b><\/h3>\n
This request requires one parameter: the campaign ID, a unique identifier for the campaign in your Snov.io account.<\/p>\n
\n
\n
To find a campaign ID, open the relevant campaign in your campaigns list. The campaign ID is the number at the end of the URL in your browser's address bar. (Example: in the campaign URL: https:\/\/app.snov.io\/campaigns\/2402609<\/a>, the ID is \"2402609\").<\/p>\n<\/div>\n<\/div>\n
Use the <\/span>\"campaign_id\"<\/b> field in the request parameters to specify the campaign you want to see progress for. One request can provide data for one campaign. Make additional requests to get progress for more campaigns.<\/span><\/p>\n
Request\u2019s result<\/strong><\/h3>\n
The \"Progress\" <\/strong>field\u00a0in the response is shown as the percentage of prospects for whom the sequence of specified campaign was completed, or for whom the sequence was stopped. The reasons for stopping sequence include: the email bounced, prospects replied, auto-replied, or unsubscribed, were deleted from the campaign or moved to another prospect list.<\/p>\n
See the full list of fields provided in the API response<\/a>.<\/p>\n
The \"Unfinished\"<\/strong> field in the response shows the number of recipients for whom the sequence is still in progress. These recipients haven\u2019t reached the sequence\u2019s end yet, and it hasn\u2019t been stopped for them (due to reasons listed in the \"Progress\" field.)<\/p>\n
The result also provides the current campaign \"Status\"<\/strong> at the time of the request. Learn more about possible campaign statuses in the knowledgebase article<\/a>.<\/p>\n","protected":false},"excerpt":{"rendered":"
Learn how to retrieve statistical data from your Snov.io account using API requests. This guide explains two requests: Get campaign analytics View campaign progress Let\u2019s review their use cases and main parameters. Get campaign analytics Before making any API request, get “access_token” using the authentication request: https:\/\/api.snov.io\/v1\/oauth\/access_token. Request\u2019s type: GET Request\u2019s URL: https:\/\/api.snov.io\/v2\/statistics\/campaign-analytics Link to […]<\/p>\n","protected":false},"author":16,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1960],"tags":[],"_links":{"self":[{"href":"https:\/\/snov.io\/knowledgebase\/wp-json\/wp\/v2\/posts\/36089"}],"collection":[{"href":"https:\/\/snov.io\/knowledgebase\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/snov.io\/knowledgebase\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/snov.io\/knowledgebase\/wp-json\/wp\/v2\/users\/16"}],"replies":[{"embeddable":true,"href":"https:\/\/snov.io\/knowledgebase\/wp-json\/wp\/v2\/comments?post=36089"}],"version-history":[{"count":0,"href":"https:\/\/snov.io\/knowledgebase\/wp-json\/wp\/v2\/posts\/36089\/revisions"}],"wp:attachment":[{"href":"https:\/\/snov.io\/knowledgebase\/wp-json\/wp\/v2\/media?parent=36089"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/snov.io\/knowledgebase\/wp-json\/wp\/v2\/categories?post=36089"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/snov.io\/knowledgebase\/wp-json\/wp\/v2\/tags?post=36089"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}