List all batches

To list all batches, use the following endpoint:

GET https://api.categoryapi.com/prod/batch

Response

This endpoint responds with 200 OK, including a list of all your batch IDs, names and categorization statuses.

[
  {
    "id": "63417246e63473562214239d",
    "name": "HubSpot form submissions",
    "status": "processing",
    "count": 96,
    "created_at": "2022-10-08 12:51:18.484000"
  },
  {
    "id": "63300bb8f9523sa325e27d6b",
    "name": "E-commerce websites",
    "status": "complete",
    "count": 694,
    "created_at": "2022-09-25 08:05:12.596000"
  },
  {
    "id": "632fc239d3cfa990d9baa09b",
    "name": "Shopify websites",
    "status": "complete",
    "count": 438,
    "created_at": "2022-09-25 02:51:37.924000"
  }
]

Batch status

The status parameter within the response will indicate the status of your batch. This can either be:

• processing if the categorization is still in progress.

• complete if all URLs have been processed and categorized.

If the batch is still processing, you can retry in a few minutes to get the complete data.

Credit usage

This API endpoint does not count toward your credit usage.