Retrieve tracking settings
The environment's open and click tracking default and its category rules. For each of opens and clicks, a send's own tracking wins, then the rule for its category, then the default, then off. Settings belong to the API key's own environment: a coss_test_… key only ever changes sandbox settings. Emails keep the settings that applied when they were sent.
bearerAuthAuthorizationBearer <token>A secret API key from the dashboard: coss_live_… for production environments, coss_test_… for sandbox environments.
Coss-Version?"2026-10-10"The API version (a date) to use for this request. Defaults to your organization's version, pinned to the latest one when it first used the API and upgraded from the dashboard. The SDK always sends the version it was built for.
"2026-10-10"The environment's tracking settings.
application/json- response
Open and click tracking settings of the API key's environment. For each of opens and clicks, a send's own tracking wins, then its category's rule, then default (the environment default; null when none is set), then off.
object*"tracking_settings""tracking_settings"default*|nullcategories*array<>Category rules, by category name.
import { Coss } from "coss";const coss = new Coss({ apiKey: process.env.COSS_API_KEY, baseUrl: "https://api.coss.com",});const { data, error } = await coss.email.tracking.get();{ "object": "tracking_settings", "default": { "object": "tracking_rule", "id": "etr_01k7c8k1d9w4x2b7n3m5q6r8st", "category": null, "opens": true, "clicks": true, "created_at": "2026-01-15T09:30:00.000Z", "updated_at": "2026-01-15T09:30:00.000Z" }, "categories": [ { "object": "tracking_rule", "id": "etr_01k7c8m4q2f3e9v6t5r1n0p8yz", "category": "password-reset", "opens": false, "clicks": false, "created_at": "2026-01-16T10:00:00.000Z", "updated_at": "2026-01-16T10:00:00.000Z" } ]}Remove the tracking default DELETE
Removes the environment default: emails without a rule for their category are then not tracked unless the send asks. Settings belong to the API key's own environment: a `coss_test_…` key only ever changes sandbox settings. Emails keep the settings that applied when they were sent.
Update a category's tracking rule PATCH
Sets the rule for emails sent with this `category`, which wins over the environment default, e.g. to track `marketing` but never `password-reset`. Fields left out keep their value; a new rule is created with them off. Settings belong to the API key's own environment: a `coss_test_…` key only ever changes sandbox settings. Emails keep the settings that applied when they were sent.