API reference

Analytics.

Email volume over time and reputation metrics. Every request needs an API key in the Authorization header; the reference overview covers keys, errors and rate limits.

Email volume over time

GET/v1/analytics/email-time-seriesFull access key

Daily counts of sent, delivered, opened, clicked, bounced and complained emails for the last 7 or 30 days (30 by default), with totals, optionally for one domain.

Query parameters
Field	Type	About
`days`	`string`	Number of days to retrieve data for (default: 30) One of `7`, `30`.
`domainId`	`string`	Filter by domain ID

terminal

curl -X GET "https://app.usenotix.dev/api/v1/analytics/email-time-series" \
  -H "Authorization: Bearer $NOTIX_API_KEY"

notix-js

import { Notix } from "notix-js";

const notix = new Notix(process.env.NOTIX_API_KEY);

const { data, error } = await notix.analytics.emailTimeSeries({ days: "7" });

notix-sdk

from notix import Notix

notix = Notix()  # reads NOTIX_API_KEY

series, _ = notix.analytics.email_time_series(days="7")

usenotix/notix-php

use Notix\Notix;

$notix = new Notix(getenv('NOTIX_API_KEY'));

$series = $notix->analytics->emailTimeSeries(['days' => '7']);

Responses

200Retrieve email time series data

200 response fields
Field	Type	About
`result`required	`object[]`
`result[].date`required	`string`
`result[].sent`required	`integer`
`result[].delivered`required	`integer`
`result[].opened`required	`integer`
`result[].clicked`required	`integer`
`result[].bounced`required	`integer`
`result[].complained`required	`integer`
`totalCounts`required	`object`
`totalCounts.sent`required	`integer`
`totalCounts.delivered`required	`integer`
`totalCounts.opened`required	`integer`
`totalCounts.clicked`required	`integer`
`totalCounts.bounced`required	`integer`
`totalCounts.complained`required	`integer`

Reputation metrics

GET/v1/analytics/reputation-metricsFull access key

Delivered, hard-bounced and complained counts with the bounce and complaint rates, optionally for one domain.

Query parameters
Field	Type	About
`domainId`	`string`	Filter by domain ID

terminal

curl -X GET "https://app.usenotix.dev/api/v1/analytics/reputation-metrics" \
  -H "Authorization: Bearer $NOTIX_API_KEY"

notix-js

import { Notix } from "notix-js";

const notix = new Notix(process.env.NOTIX_API_KEY);

const { data, error } = await notix.analytics.reputationMetrics();

notix-sdk

from notix import Notix

notix = Notix()  # reads NOTIX_API_KEY

reputation, _ = notix.analytics.reputation_metrics()

usenotix/notix-php

use Notix\Notix;

$notix = new Notix(getenv('NOTIX_API_KEY'));

$reputation = $notix->analytics->reputationMetrics();

Responses

200Retrieve reputation metrics data

200 response fields
Field	Type	About
`delivered`required	`integer`
`hardBounced`required	`integer`
`complained`required	`integer`
`bounceRate`required	`number`
`complaintRate`required	`number`