Acceptances per template version
GET/v1/click/reports/acceptances
One row per template and version in one environment: how many acceptances were accepted, declined and expired in the window, how many distinct signers accepted, how many of those are current, and how many accepted acceptances were erased. Read it to see how far a re-acceptance campaign has got.
- Window.
fromandtoare required, inclusive, and at most 366 days apart. An acceptance falls in the window by when it was completed (or started, for one never completed). - Signers are distinct, non-erased signer references with an accepted acceptance of that version. A declined or expired acceptance never makes a signer.
- Current uses the same rule as signer status, grace window included: a signer is current when they ever accepted a major that a deployment of the template in this environment serves.
currentSignerscounts the signers of the row who are current on at least one such deployment. A version of an older major can therefore have current signers, if they also accepted the major now served. - Erased acceptances (
erasedAcceptances) are accepted acceptances whose signer identity was erased. They are counted only there: never insignersorcurrentSigners, and never merged into one signer. servedBylists the deployments whose served majors include this version’s major;graceEndsAtis set when only a superseded revision still serves it.- Filtering by signer is not possible here: a signer reference in a URL reaches load-balancer logs, so
signerRefon this operation is a 400. UsePOST /v1/click/reports/acceptances/query. - Caching. Every response, errors included, is
Cache-Control: private, no-store.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 503
A page of report rows, newest version first within each template
Response Headers
Correlation id for this request, returned on every response (success and error). Quote it when contacting support to pinpoint the exact request, and use it to correlate your own logs. It is the same 128-bit id as the trace-id segment of the traceparent header.
W3C Trace Context identifier for this request, returned on every response. Send your own traceparent on a request to have it adopted, so a multi-call workflow shares one trace. Format: 00-<32-hex trace-id>-<16-hex span-id>-<2-hex flags>.
CLICK_VALIDATION_FAILED for a missing or invalid filter, a window over 366 days or an unknown filter, and CLICK_BAD_REQUEST for signerRef on a URL
Response Headers
Correlation id for this request, returned on every response (success and error). Quote it when contacting support to pinpoint the exact request, and use it to correlate your own logs. It is the same 128-bit id as the trace-id segment of the traceparent header.
W3C Trace Context identifier for this request, returned on every response. Send your own traceparent on a request to have it adopted, so a multi-call workflow shares one trace. Format: 00-<32-hex trace-id>-<16-hex span-id>-<2-hex flags>.
The credentials are missing, invalid or expired (CLICK_UNAUTHORIZED).
Response Headers
Correlation id for this request, returned on every response (success and error). Quote it when contacting support to pinpoint the exact request, and use it to correlate your own logs. It is the same 128-bit id as the trace-id segment of the traceparent header.
W3C Trace Context identifier for this request, returned on every response. Send your own traceparent on a request to have it adopted, so a multi-call workflow shares one trace. Format: 00-<32-hex trace-id>-<16-hex span-id>-<2-hex flags>.
The token lacks the scope this operation needs, or the resource belongs to another organization (CLICK_FORBIDDEN), or your account does not include Click (ENTITLEMENT_REQUIRED, with requiredEntitlement).
Response Headers
Correlation id for this request, returned on every response (success and error). Quote it when contacting support to pinpoint the exact request, and use it to correlate your own logs. It is the same 128-bit id as the trace-id segment of the traceparent header.
W3C Trace Context identifier for this request, returned on every response. Send your own traceparent on a request to have it adopted, so a multi-call workflow shares one trace. Format: 00-<32-hex trace-id>-<16-hex span-id>-<2-hex flags>.
CLICK_NOT_FOUND: the template or version does not exist in your organization
Response Headers
Correlation id for this request, returned on every response (success and error). Quote it when contacting support to pinpoint the exact request, and use it to correlate your own logs. It is the same 128-bit id as the trace-id segment of the traceparent header.
W3C Trace Context identifier for this request, returned on every response. Send your own traceparent on a request to have it adopted, so a multi-call workflow shares one trace. Format: 00-<32-hex trace-id>-<16-hex span-id>-<2-hex flags>.
A dependency is temporarily unavailable (CLICK_SERVICE_UNAVAILABLE, or a more specific code). Retry with backoff.
Response Headers
Correlation id for this request, returned on every response (success and error). Quote it when contacting support to pinpoint the exact request, and use it to correlate your own logs. It is the same 128-bit id as the trace-id segment of the traceparent header.
W3C Trace Context identifier for this request, returned on every response. Send your own traceparent on a request to have it adopted, so a multi-call workflow shares one trace. Format: 00-<32-hex trace-id>-<16-hex span-id>-<2-hex flags>.