Get Metrics Breakdown

GET

api

metrics

breakdown

curl --request GET \
  --url https://api.sequenzy.com/api/v1/metrics/breakdown \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sequenzy.com/api/v1/metrics/breakdown', 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.sequenzy.com/api/v1/metrics/breakdown",
  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.sequenzy.com/api/v1/metrics/breakdown"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/metrics/breakdown")

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

{
  "by": "<string>",
  "period": "<string>",
  "start": "<string>",
  "end": "<string>",
  "rows": [
    {}
  ]
}

Returns the delivery funnel for each value of one dimension, most sends first. Use it to find which email, sequence, mailbox provider or recipient domain is behind a number, then drill into that row by passing its filter to Get Metrics or to another breakdown. Rows count the sends made in the window and the engagement those sends earned, the same way Get Metrics does, so the rows of a complete breakdown add up to its totals. Test sends are excluded, and detected scanners and privacy proxies are excluded unless you set includeMachineEngagement=true. For example, to see which step of a sequence earns its revenue and how it lands at Microsoft:

GET /api/v1/metrics/breakdown?by=sequence and take the row’s filter.source, such as sequence:seq_123.
GET /api/v1/metrics/breakdown?by=email&source=sequence:seq_123 for each step.
GET /api/v1/metrics/breakdown?by=recipient_domain&source=sequence:seq_123&mailboxProvider=microsoft to compare Outlook and Hotmail.

Query Parameters

string

default:"email"

Dimension to group by: email (one row per campaign, sequence email step and transactional template), sequence, email_type, mailbox_provider or recipient_domain.

string

default:"30d"

Sliding window over send times. One of: 1h, 24h, 7d, 30d, 90d. Ignored when start and end are provided.

string

Start of custom time range (ISO 8601). Must be used with end.

string

End of custom time range (ISO 8601). Must be used with start. Max range: 90 days.

string

Optional structural filter: campaign, sequence, or transactional. Marketer-role personal keys only see the emails their role can open, and receive 403 for transactional.

string

Optional recipient mailbox provider filter, for example gmail, microsoft, yahoo, or icloud.

string

Optional recipient domain filter, for example outlook.com.

string

Optional email source filter as <type>:<id>: campaign:<campaignId>, sequence:<sequenceId>, sequence_step:<email step id> or transactional:<transactional email id>. Returns 404 when the source is not in this company or your key cannot see it.

number

default:"25"

Number of rows to return, from 1 to 100.

boolean

default:"false"

Set to true to include detected scanner, preview, and tracked asset open/click events.

Response Fields

string

The dimension the rows are grouped by.

string

Applied period, or custom when start and end were provided.

string

Start of the window the rows cover.

string

End of the window the rows cover.

array

One row per dimension value, most sends first. Each row has key (the id, email type, provider or domain; empty when the events predate the column), label, detail (for example the sequence an email step belongs to, or null), sent, delivered, opened, clicked, bounced, complained, unsubscribed, and the rates deliveryRate and bounceRate (of sent) and openRate, clickRate and unsubscribeRate (of delivered).conversions and revenue (attributed revenue in currency units) count the orders credited to the row’s sends. For mailbox_provider and recipient_domain, and with mailboxProvider or recipientDomain set, each conversion counts toward the provider and domain of the send it was attributed to.filter is the filter that narrows a later request to the row: {"kind": "source", "source": {"type": "sequence", "id": "seq_123"}} (pass it as source=sequence:seq_123), {"kind": "email_type", "emailType": "campaign"}, {"kind": "mailbox_provider", "mailboxProvider": "gmail"} or {"kind": "recipient_domain", "recipientDomain": "gmail.com"}. It is null when the row cannot be drilled into, for example an email whose campaign was deleted.

emailType, mailboxProvider, recipientDomain and source are echoed back when you provide them.

Errors

Status	When
`400`	Invalid `by`, period, date range, email type, mailbox provider, domain, source or `limit`
`401`	Missing or invalid API key
`403`	A marketer-role personal key requested `emailType=transactional`
`404`	The `source` is not in this company or your key cannot see it
`500`	Analytics storage error; retry the request

Get Metrics Breakdown

curl --request GET \
  --url https://api.sequenzy.com/api/v1/metrics/breakdown \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sequenzy.com/api/v1/metrics/breakdown', 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.sequenzy.com/api/v1/metrics/breakdown",
  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.sequenzy.com/api/v1/metrics/breakdown"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/metrics/breakdown")

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

{
  "by": "<string>",
  "period": "<string>",
  "start": "<string>",
  "end": "<string>",
  "rows": [
    {}
  ]
}

​Query Parameters

​Response Fields

​Errors

Query Parameters

Response Fields

Errors