correlation

Get correlation job status

Poll the status of a correlation job.

Returns the current job status. When status is "completed", the full correlation result (clusters, pairwise scores, summaries) is included.

get/correlate/{correlation_id}

Request

  • Base URL: https://api.whoisgeni.us (the document declares no server; this is the origin it was published from)
  • URL: https://api.whoisgeni.us/correlate/{correlation_id}
  • Auth: none declared

Path parameters

correlation_idstring required

Headers

X-API-Keystring nullable

Response

Correlation job status and result

metaobject nullable

Example response

{
  "data": {
    "correlation_id": "3f6b8c2a-7a1d-4e5f-9b0c-2d4e6f8a0b1c",
    "domain_count": 7,
    "status": "completed"
  },
  "error": {
    "code": "JOB_NOT_FOUND",
    "message": "No job found with the given ID."
  }
}

Changes

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