Orgs Analytics
Get Broadcasts Overview
Org-wide broadcast analytics for a period: delivery funnel, volume over time, channel and failure breakdowns, and per-broadcast performance.
GET
/
orgs
/
{org_id}
/
analytics
/
broadcasts
/
overview
Get Broadcasts Overview
curl --request GET \
--url https://api.useinvent.com/orgs/{org_id}/analytics/broadcasts/overview \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.useinvent.com/orgs/{org_id}/analytics/broadcasts/overview"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.useinvent.com/orgs/{org_id}/analytics/broadcasts/overview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.useinvent.com/orgs/{org_id}/analytics/broadcasts/overview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.useinvent.com/orgs/{org_id}/analytics/broadcasts/overview"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.useinvent.com/orgs/{org_id}/analytics/broadcasts/overview")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.useinvent.com/orgs/{org_id}/analytics/broadcasts/overview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"kpis": {
"sent": 123,
"sent_previous": 123,
"delivery_rate": 123,
"open_rate": 123,
"click_rate": 123,
"failed": 123,
"unsubscribed": 123
},
"funnel": {
"recipients": 123,
"queued": 123,
"sent": 123,
"delivered": 123,
"opened": 123,
"played": 123,
"clicked": 123,
"skipped": 123,
"failed": 123,
"bounced": 123,
"unsubscribed": 123,
"complained": 123
},
"volume": [
{
"key": "<string>",
"points": [
{
"date": "2023-11-07T05:31:56Z",
"amount": 123
}
]
}
],
"by_channel": [
{
"integration_id": "<string>",
"recipients": 123,
"sent": 123,
"delivered": 123,
"failed": 123
}
],
"failure_reasons": [
{
"reason": "<string>",
"count": 123
}
],
"broadcasts": [
{
"broadcast_id": "<string>",
"broadcast_name": "<string>",
"sent_at": "<string>",
"total": 123,
"sent": 123,
"delivered": 123,
"opened": 123,
"failed": 123,
"bounced": 123,
"skipped": 123,
"delivery_rate": 123,
"open_rate": 123,
"clicked": 123
}
]
}Authorizations
Bearer token authentication using your API key
Path Parameters
Query Parameters
Available options:
hour, day, week, month, year IANA timezone identifier (e.g. America/New_York)
Response
200 - application/json
Was this page helpful?
⌘I
Get Broadcasts Overview
curl --request GET \
--url https://api.useinvent.com/orgs/{org_id}/analytics/broadcasts/overview \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.useinvent.com/orgs/{org_id}/analytics/broadcasts/overview"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.useinvent.com/orgs/{org_id}/analytics/broadcasts/overview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.useinvent.com/orgs/{org_id}/analytics/broadcasts/overview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.useinvent.com/orgs/{org_id}/analytics/broadcasts/overview"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.useinvent.com/orgs/{org_id}/analytics/broadcasts/overview")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.useinvent.com/orgs/{org_id}/analytics/broadcasts/overview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"kpis": {
"sent": 123,
"sent_previous": 123,
"delivery_rate": 123,
"open_rate": 123,
"click_rate": 123,
"failed": 123,
"unsubscribed": 123
},
"funnel": {
"recipients": 123,
"queued": 123,
"sent": 123,
"delivered": 123,
"opened": 123,
"played": 123,
"clicked": 123,
"skipped": 123,
"failed": 123,
"bounced": 123,
"unsubscribed": 123,
"complained": 123
},
"volume": [
{
"key": "<string>",
"points": [
{
"date": "2023-11-07T05:31:56Z",
"amount": 123
}
]
}
],
"by_channel": [
{
"integration_id": "<string>",
"recipients": 123,
"sent": 123,
"delivered": 123,
"failed": 123
}
],
"failure_reasons": [
{
"reason": "<string>",
"count": 123
}
],
"broadcasts": [
{
"broadcast_id": "<string>",
"broadcast_name": "<string>",
"sent_at": "<string>",
"total": 123,
"sent": 123,
"delivered": 123,
"opened": 123,
"failed": 123,
"bounced": 123,
"skipped": 123,
"delivery_rate": 123,
"open_rate": 123,
"clicked": 123
}
]
}