get sales channel performance

Revenue per sales channel over a window: each channel with its total revenue, the difference against the previous period of the same length, the change as a percentage, and a dated series at the requested granularity.

start_date and end_date are required and the window may not exceed one year. sales_channel_ids narrows the channels, and granularity sets the series' step.

A key issued to one account is refused with account_mismatch: this read covers every account on the book. That account's own sales are at GET /sales/table.

Scope: sales:read.

get/api/v1/sales/performance/channels

Request

Base URL: https://api.app.tightly.io
URL: https://api.app.tightly.io/api/v1/sales/performance/channels
Auth: HTTP bearer

Query parameters

start_datestring date required

Example:2025-11-01

Start date for the current period (ISO date format YYYY-MM-DD)

end_datestring date required

Example:2025-11-08

End date for the current period (ISO date format YYYY-MM-DD). Maximum range is 1 year from start_date.

sales_channel_idsstring

Comma-separated list of sales channel IDs to filter. If not provided, returns all channels.

granularity'day' | 'week' | 'month'

Time granularity for the data points (day, week, or month)

Headers

Tightly-Versionstring

Example:2026-11

The date train to answer on. One train exists today, 2026-11, the one this reference describes and the one every key is minted on, so the call answers on it with or without this header. Send it anyway, so a client built now names its train from the start.

Response

Performance by sales channel

Example response

{
  "data": {
    "channels": [
      {
        "change_percentage": 12.5,
        "channel_name": "Amazon",
        "data": [
          {
            "date": "2025-11-01",
            "revenue": 45000
          }
        ],
        "period_difference": 34000.25,
        "sales_channel_id": "ch_123",
        "total_revenue": 453000.5
      }
    ]
  },
  "message": {
    "desc": "Success",
    "service": "sales",
    "severity": "info"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.