Sign in

v1

latestOpenAPI 3.1.02026-08-04272636.0 KB
alignment

List Client Alignments

The current Red/Amber/Green alignment read for every client, as shown in the Alignment column of the Commercial Intelligence report.

get/v1/clients/alignment

Query parameters

weekstring nullable

Resolve reads as of this week (YYYY-MM-DD, typically a Monday). Reads filed for later weeks are ignored. Defaults to the latest read.

Resolve reads as of this week (YYYY-MM-DD, typically a Monday). Reads filed for later weeks are ignored. Defaults to the latest read.

include_archivedboolean
limitinteger
offsetinteger

Response

Successful Response

totalinteger required
weekstring nullable

As-of week the reads were resolved against; null when the latest reads were returned

customerIdstring required
All 27 operations