Result handling

All endpoints in Data API use result links to handle request outputs. This approach ensures reliable handling of long-running requests and large data retrievals.

Initial request

When you make a request, the API immediately returns a link that you can use to check the result status:

{
  "status": "processing",
  "process": {
    "message": "Your request is being processed. Please check the resultLink periodically.",
    "resultLink": "https://api.linkedapi.io/data/results/{someShortHash}"
  }
}

If there's a global error, you'll receive:

{
  "status": "error",
  "error": {
    "errorType": "invalidRequestBody",
    "message": "The request body is invalid: {validation_details}."
  }
}

Result retrieval

Make periodic GET requests to the provided resultLink until you receive a response with status complete:

GET https://api.linkedapi.io/data/results/{someShortHash}

You'll receive one of these responses:

1. While processing:

{
  "status": "processing",
  "process": {
    "message": "Your request is being processed. Please check the resultLink later.",
    "resultLink": "https://api.linkedapi.io/data/results/{someShortHash}"
  }
}

2. When complete:

{
  "status": "complete",
  "completion": { ... }
}