M1 Hub
Back to user guides

M1 RetroScore API User Guide

  1. Getting started
  2. List searches
  3. Create search
  4. Get search metadata
  5. Get search results
  6. Check search status
    1. Request
    2. Response
  7. Delete search

Check search status

Request

GET

http://localhost:2222/api/v2/batch-search-status/{id}

#{id}
string
required

ID of the search.

Example

curl http://localhost:2222/api/v2/batch-search-status/{id} \
  -H "Authorization: ApiToken-v1 YOUR_API_TOKEN"

Response

Body application/json

#queued
integer

Number of queued searches.

#running
integer

Number of running searches.

#finished
integer

Number of finished searches.

#error
integer

Number of searches that failed.

Example

{
  "queued": 2,
  "running": 0,
  "finished": 0,
  "error": 0
}