internal

Get Marketing Client Metrics

Client metrics digest for a company: one fortnight vs the one before.

The risk metrics cover four complete ISO weeks ending at end_week; the in-progress week is never included, since it always under-reads until reviewing catches up. Eligible uploads reviewed is reported by month instead -- see _client_metrics_month_spans for why those months end where the weeks do rather than at the generation date.

team_ids scopes the whole document. Every figure then covers those teams together, and from two teams up the document also carries a per-team drilldown of each of them -- summed from the same query rows as the totals, so the parts add up to the whole by construction.

get/internal/reliability/marketing/client-metrics

Query parameters

company_idstring uuid required
team_idsstring[] nullable

Marketing teams to scope the digest to, repeated. Omit the parameter entirely for the whole company -- an empty value is a malformed uuid, not company-wide. The whole company is not the same as naming every team: collateral belonging to no team, and a risk raised on a file that is not marketing collateral, are only counted when no team is named. Two or more teams add a per-team drilldown of every headline metric. At most 12.

Marketing teams to scope the digest to, repeated. Omit the parameter entirely for the whole company -- an empty value is a malformed uuid, not company-wide. The whole company is not the same as naming every team: collateral belonging to no team, and a risk raised on a file that is not marketing collateral, are only counted when no team is named. Two or more teams add a per-team drilldown of every headline metric. At most 12.

end_weekstring date nullable

Monday of the last week to include. Defaults to the most recent complete week; a mid-week date snaps back to its Monday.

Monday of the last week to include. Defaults to the most recent complete week; a mid-week date snaps back to its Monday.

Response

Successful Response

company_idstring uuid required
company_namestring required
company_team_countinteger required
current_startstring date required
current_endstring date required
prior_startstring date required
markdownstring required

Changes

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