Brand overview (totals, rates, timeseries)

curl --request GET \
  --url https://brew.new/api/v1/analytics/overview \
  --header 'Authorization: Bearer <token>'

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

fetch('https://brew.new/api/v1/analytics/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://brew.new/api/v1/analytics/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://brew.new/api/v1/analytics/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))

}

require 'uri'
require 'net/http'

url = URI("https://brew.new/api/v1/analytics/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

{
  "totals": {
    "sent": 5000,
    "delivered": 4920,
    "opened": 2110,
    "clicked": 540,
    "bounced": 80,
    "complained": 3,
    "unsubscribed": 12,
    "failed": 0,
    "suppressed": 14,
    "deliveryDelayed": 2
  },
  "rates": {
    "deliveryRate": 0.984,
    "openRate": 0.4289,
    "clickRate": 0.1098,
    "bounceRate": 0.016,
    "complaintRate": 0.0006,
    "unsubscribeRate": 0.0024
  },
  "buckets": [
    {
      "at": "2026-04-08T00:00:00.000Z",
      "sent": 5000,
      "delivered": 4920,
      "deliveryDelayed": 2,
      "opened": 2110,
      "clicked": 540,
      "bounced": 80,
      "complained": 3,
      "failed": 0,
      "suppressed": 14,
      "unsubscribed": 12
    }
  ],
  "granularity": "1d",
  "timeZone": "America/New_York",
  "range": {
    "from": "2026-04-01T12:34:56.789Z",
    "to": "2026-04-08T12:34:56.789Z"
  },
  "truncated": false
}

{
  "error": {
    "code": "INVALID_REQUEST",
    "type": "invalid_request",
    "message": "Request validation failed.",
    "suggestion": "Fix the field reported in `param` and retry.",
    "docs": "https://docs.brew.new/api-reference/api/errors",
    "param": "from"
  }
}

{
  "error": {
    "code": "INVALID_API_KEY",
    "type": "authentication_error",
    "message": "The provided API key is invalid.",
    "suggestion": "Check the API key format and retry with a valid active key.",
    "docs": "https://docs.brew.new/api-reference/api/authentication"
  }
}

{
  "error": {
    "code": "INSUFFICIENT_PERMISSIONS",
    "type": "authorization_error",
    "message": "The caller does not have the required permission.",
    "suggestion": "Use an API key or session with the required permission.",
    "docs": "https://docs.brew.new/api-reference/api/authentication",
    "param": "emails"
  }
}

{
  "error": {
    "code": "RATE_LIMITED",
    "type": "rate_limit",
    "message": "Too many requests.",
    "suggestion": "Wait for the retry window before sending another request.",
    "docs": "https://docs.brew.new/api-reference/api/rate-limits",
    "retryAfter": 42
  }
}

{
  "error": {
    "code": "INTERNAL_ERROR",
    "type": "internal_error",
    "message": "An unexpected error occurred.",
    "suggestion": "Retry the request. If it keeps failing, contact support.",
    "docs": "https://docs.brew.new/api-reference/api/errors"
  }
}

Analytics

Brand overview (totals, rates, timeseries)

Windowed brand overview — the EXACT read behind the app’s /analytics metric cards + chart (same per-recipient dedup and machine-click/open exclusion rules), so API/MCP numbers can never disagree with the page. Defaults to the last 7 days. Optional filters, all of which COMPOSE freely: source (csv of send sources), automationId, emailId, audienceId (csv, ≤20), triggerEventId (csv, ≤10 — integration trigger-events, resolved to their wired automations), domain (sending domain), and recipient (csv of recipient rules — same grammar and name as GET /v1/analytics/events). A single filter is answered from pre-aggregated rollup rows; any combination (and anything with domain or recipient, neither of which has a rollup dimension) is answered by aggregating raw events instead — exact, but capped, so watch truncated on wide windows. Returns { totals, rates, buckets, granularity, timeZone, range, truncated } — truncated: true means the window exceeded the scan budget; narrow the range. Requires the emails scope.

GET

analytics

overview

curl --request GET \
  --url https://brew.new/api/v1/analytics/overview \
  --header 'Authorization: Bearer <token>'

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

fetch('https://brew.new/api/v1/analytics/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://brew.new/api/v1/analytics/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://brew.new/api/v1/analytics/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))

}

require 'uri'
require 'net/http'

url = URI("https://brew.new/api/v1/analytics/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

{
  "totals": {
    "sent": 5000,
    "delivered": 4920,
    "opened": 2110,
    "clicked": 540,
    "bounced": 80,
    "complained": 3,
    "unsubscribed": 12,
    "failed": 0,
    "suppressed": 14,
    "deliveryDelayed": 2
  },
  "rates": {
    "deliveryRate": 0.984,
    "openRate": 0.4289,
    "clickRate": 0.1098,
    "bounceRate": 0.016,
    "complaintRate": 0.0006,
    "unsubscribeRate": 0.0024
  },
  "buckets": [
    {
      "at": "2026-04-08T00:00:00.000Z",
      "sent": 5000,
      "delivered": 4920,
      "deliveryDelayed": 2,
      "opened": 2110,
      "clicked": 540,
      "bounced": 80,
      "complained": 3,
      "failed": 0,
      "suppressed": 14,
      "unsubscribed": 12
    }
  ],
  "granularity": "1d",
  "timeZone": "America/New_York",
  "range": {
    "from": "2026-04-01T12:34:56.789Z",
    "to": "2026-04-08T12:34:56.789Z"
  },
  "truncated": false
}

{
  "error": {
    "code": "INVALID_REQUEST",
    "type": "invalid_request",
    "message": "Request validation failed.",
    "suggestion": "Fix the field reported in `param` and retry.",
    "docs": "https://docs.brew.new/api-reference/api/errors",
    "param": "from"
  }
}

{
  "error": {
    "code": "INVALID_API_KEY",
    "type": "authentication_error",
    "message": "The provided API key is invalid.",
    "suggestion": "Check the API key format and retry with a valid active key.",
    "docs": "https://docs.brew.new/api-reference/api/authentication"
  }
}

{
  "error": {
    "code": "INSUFFICIENT_PERMISSIONS",
    "type": "authorization_error",
    "message": "The caller does not have the required permission.",
    "suggestion": "Use an API key or session with the required permission.",
    "docs": "https://docs.brew.new/api-reference/api/authentication",
    "param": "emails"
  }
}

{
  "error": {
    "code": "RATE_LIMITED",
    "type": "rate_limit",
    "message": "Too many requests.",
    "suggestion": "Wait for the retry window before sending another request.",
    "docs": "https://docs.brew.new/api-reference/api/rate-limits",
    "retryAfter": 42
  }
}

{
  "error": {
    "code": "INTERNAL_ERROR",
    "type": "internal_error",
    "message": "An unexpected error occurred.",
    "suggestion": "Retry the request. If it keeps failing, contact support.",
    "docs": "https://docs.brew.new/api-reference/api/errors"
  }
}

Authorizations

Authorization

string

header

default:Bearer brew_your_api_key

required

Send your Brew API key as Authorization: Bearer brew_xxx.

Headers

X-Brand-Id

string

The brand this request acts on. REQUIRED for organization-scoped credentials (otherwise 400 BRAND_ID_REQUIRED — there is no default brand); list ids with GET /v1/brands. Brand-scoped credentials may omit it, and sending a different brand returns 403 BRAND_SCOPE_MISMATCH. A brand outside your organization returns 404 BRAND_NOT_FOUND.

Required string length: 1 - 64

Query Parameters

from

string<date-time>

source

string

CSV of send sources to include (e.g. audience,api; valid values: audience, api, automation_manual, automation_integration, automation_custom). Composes with every other filter.

Required string length: 1 - 256

automationId

string

CSV of automation ids (max 20) — a single id is still valid. Composes with every other filter; one id reads a pre-aggregated rollup partition, several take the raw-event path.

Required string length: 1 - 2048

emailId

string

Scope to one email design. Composes with every other filter — a design used by several automations can be narrowed with automationId.

Required string length: 1 - 64

audienceId

string

CSV of audience ids (max 20). Composes with every other filter.

Required string length: 1 - 2048

triggerEventId

string

CSV of integration trigger-event ids (max 10), resolved to their wired automations. Composes with every other filter.

Required string length: 1 - 2048

domain

string

Sending domain (fromEmail match). Has no rollup dimension, so requests carrying it are answered from raw events — check truncated on wide windows.

Required string length: 1 - 255

recipient

string

CSV of recipient rules (max 10) matching who RECEIVED the email — the SAME grammar and the same parameter name as GET /v1/analytics/events, so one filter string moves between the two and the totals here describe exactly the rows that feed lists. A full address matches exactly, @domain matches the domain, any other text matches as a substring; prefix ! to exclude (e.g. @clay.com,!ceo@clay.com). Includes OR together; excludes always apply. Like domain this has no rollup dimension (stored rows aggregate ACROSS recipients), so requests carrying it are answered from raw events — check truncated on wide windows.

Required string length: 1 - 2048

Response

Brand-wide totals, rates, and a zero-filled timeseries for the window.

totals

object

required

Show child attributes

rates

object

required

Show child attributes

buckets

object[]

required

Show child attributes

granularity

enum<string>

required

Available options:

5m,

1h,

1d

timeZone

string

required

range

object

required

Show child attributes

truncated

boolean

required

⌘I

Get started

Overview

Core concepts

Guides

MCP server

CLI

Public API v1

Brand overview (totals, rates, timeseries)

Authorizations

Headers

Query Parameters

Response