Metrics API

Golden 3.0.0 public API reference. Parameters, responses, and schemas for supported customer operations.

3 operations.

GET /api/metrics/tables/{table}/families/{family}

Retrieves the daily metric snapshots of one table and one family.

Operation ID: getDailyMetrics

Retrieves the daily snapshots of a metric family for one table, ascending by day. The families that exist are enumerated on the family parameter. Both bounds are required, are inclusive, and are UTC days; the range must not be inverted, must end on a day that has already closed, and may span at most 366 days. An unknown table or family answers 404; a valid range holding no snapshots answers 200 with an empty list. Requires the ADMIN, STEWARD or VIEWER role.

Security: bearerAuth

Parameters

Responses

GET /api/metrics/tables/{table}/measurements

Retrieves the quality measurements of one table.

Operation ID: getMeasurements

Retrieves the quality measurements taken on demand of one table whose instant falls in an inclusive window of UTC days, newest first, at most 200. Unlike the daily read, the window may end today. The range must not be inverted and may span at most 366 days. An unknown table answers 404; a valid range holding no measurements answers 200 with an empty list. Requires the ADMIN, STEWARD or VIEWER role.

Security: bearerAuth

Parameters

Responses

POST /api/quality/measurements

Measures one entity’s quality now.

Operation ID: measure

Takes a quality measurement of the entity’s table as it stands now - the same two payloads the daily snapshot carries - and stores it with the instant it was taken and an optional label of at most 120 characters. It does not recalculate records first. Asynchronous - returns the run to poll. Answers 409 while a measurement of the same entity is already running. Requires the ADMIN role.

Security: bearerAuth

Request body

Responses