User Task Status API

​

Report the state of an asynchronous users upload or delete.

POST /v1/users and POST /v1/users/_delete return a task_id. The records are written in the background, so a 200 on the upload means accepted, not indexed. Poll this endpoint with the task id until the response is no longer pending.

{ "message": "pending" }

When the batch is written, the response reports one entry per record:

{
  "message": "success",
  "data": {
    "items": [
      { "id": "product_1", "status": "created" }
    ]
  }
}

Poll every 2 seconds. A task id that is unknown or expired returns 404.

Path Parameters
  • task_id
    Type: string
    required

    The task id from the upload or delete response.

Responses
  • application/json
  • 401

    The API key is missing or wrong.

  • 404

    The task id is unknown or it expired.

  • 422

    The request did not pass validation.

Request Example for get/v1/users/_status/{task_id}
curl 'https://api.askmiso.com/v1/users/_status/{task_id}?api_key=YOUR_SECRET_TOKEN'

{
  "message": "success",
  "data": {
    "items": [
      {
        "id": "product_1",
        "status": "created"
      }
    ]
  }
}

Successful Response