Explicitly enabled aggregate coverage for a named release

GET

https://api.datafortennis.com/v1/coverage/summary

GET

/v1/coverage/summary

const url = 'https://api.datafortennis.com/v1/coverage/summary';
const options = {method: 'GET'};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "data": [
    {
      "family": "string",
      "discipline": "string",
      "census": "string",
      "available": "string",
      "missing": "string",
      "unknown": "string",
      "not_applicable": "string",
      "known_applicable": "string",
      "missing_assessment": "string",
      "partial": "string",
      "usable_rows": "string",
      "derived_rows": "string",
      "definition": "enrichment/1",
      "grain": "point",
      "point_numerator": "string",
      "point_denominator": "string",
      "density": "string",
      "conflict_rows": "string",
      "category": "string"
    }
  ],
  "meta": {
    "release_id": "string",
    "epoch": "string",
    "schema_version": "string",
    "quality_version": "string",
    "cutoff": "string",
    "definition": "coverage/1",
    "census_scope": "named_release",
    "season": 1,
    "discipline": "singles",
    "calendar": {
      "precision": "day",
      "unknown_dates_excluded": true,
      "complete_calendar": true
    },
    "capability": {
      "family": "rally",
      "status": "supported",
      "definition": "enrichment/1"
    },
    "category": "string"
  },
  "page": {
    "limit": 1,
    "next_cursor": "string"
  },
  "error": null
}

Query parameters

releasestringOptionalformat: "^[a-z0-9][a-z0-9-]{0,79}$"

seasonstringOptionalformat: "^(19|20|21)[0-9]{2}$"

disciplineenumOptional

Allowed values:

categorystringOptionalformat: "^[A-Za-z0-9][A-Za-z0-9 _-]{0,63}$"

Exact canonical category, for example Challenger. This filter is bound into pagination and retry identity.

Response

Pinned release data. Missing families return an empty array and coverage reasons.

datalist of objects

metaobject

pageobject or null

errorobject or null

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

410

Gone Error

413

Content Too Large Error

414

URI Too Long Error

429

Too Many Requests Error

503

Service Unavailable Error