Get export status and manifest

GET

https://api.datafortennis.com/v1/exports/:exportId

GET

/v1/exports/:exportId

const url = 'https://api.datafortennis.com/v1/exports/exportId';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "data": {
    "id": "string",
    "state": "queued",
    "release_id": "string",
    "epoch": "string",
    "progress_rows": "string",
    "created_at": "string",
    "expires_at": "string",
    "manifest": {
      "release_id": "string",
      "epoch": "string",
      "schema_version": "string",
      "mapping_version": "string",
      "quality_version": "string",
      "metric_definition": "string",
      "family": "points",
      "grain": "point",
      "filters": {
        "season": 1,
        "discipline": "singles",
        "match_ids": [
          "string"
        ]
      },
      "rows": "string",
      "bytes": "string",
      "canonical_sha256": "string",
      "coverage": {
        "release_id": "string",
        "epoch": "string",
        "family": "string",
        "format": "string",
        "estimated_rows": "string",
        "census_matches": "string",
        "with_rows": "string",
        "unknown_pbp_assessment": "string",
        "walkovers": "string",
        "row_limit": "string",
        "byte_limit": "string",
        "confidence": "exact_prepared_counts",
        "estimated_bytes": null,
        "fits_rows": true
      },
      "files": [
        {
          "id": "string",
          "format": "ndjson",
          "rows": "string",
          "bytes": "string",
          "sha256": "string"
        }
      ]
    },
    "error_code": "string"
  },
  "meta": {
    "release_id": "string",
    "epoch": "string",
    "schema_version": "string",
    "quality_version": "string",
    "availability": [
      {
        "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"
      }
    ],
    "calendar": {
      "precision": "day",
      "unknown_dates_excluded": true,
      "complete_calendar": true
    },
    "capability": {
      "family": "rally",
      "status": "supported",
      "definition": "enrichment/1"
    }
  },
  "page": {
    "limit": 1,
    "next_cursor": "string"
  },
  "error": null
}

Owner-only export control. Unknown and foreign IDs return 404. Cancellation preserves canonical facts and metering receipts.

Authentication

AuthorizationBearer

Private development credential: keyId.secret; rotate/revoke through the offline operations CLI.

Path parameters

exportIdstringRequiredformat: "^exp_[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$"

Response headers

X-Operation-IdstringOptionalformat: "uuid"

Durable logical operation UUID; shared by keyed retries. Not a credential.

Response

Private export control result.

dataobject

metaobject or null

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