Monitoring Import Progress And Status

In this section, you’ll learn how to monitor your imported data i.e. the progress and status of documents you have submitted to the Meltwater API.

The Meltwater API /imports/documents returns a batch_id in the JSON response. You can use this batch_id to monitor the status of your imported documents.

Batch: This is a group of documents that is imported together in a single API request.

API Endpoints

The following endpoints are available to monitor your imported data:

1. List All Batches

Retrieve all batches for your company, filtered by time or status:

GET /byoc/batches

Query Parameters:

• start (optional): Start timestamp for filtering batches (ISO 8601 format without timezone).
• end (optional): End timestamp for filtering batches (ISO 8601 format without timezone).
• tz (optional): Timezone for interpreting the start and end input timestamps (default is UTC). This also determines the timezone for any timestamps in the output response.
• status (optional): Comma-separated list of statuses to filter by (e.g). PENDING, FINISHED, FAILED).
• page (optional): Page number for pagination (default is 1).
• page_size (optional): Number of items per page (default is 20, maximum is 100).
• company_id (optional): Meltwater company id if running a request on behalf of another company

curl -X GET \
--url "https://api.meltwater.com/v3/imports/batches" \
--header "Accept: application/json" \
--header "apikey: **********"

Example Response

{
   "content": [
      {
         "batch_id": "659d65a6-0937-406a-86da-9d2aa537dfef",
         "created_at": "2025-07-24T12:11:31Z",
         "statistics": {
            "documents_sent": 2,
            "documents_indexed": 2,
            "subgroups": {
               "social": {
                  "documents_indexed": 1
               },
               "editorial": {
                  "documents_indexed": 1
               }
            }
         },
         "status": "FINISHED"
      }
   ],
   "page": 1,
   "page_size": 1,
   "total": 1
}

• documents_sent: Number of documents sent (if available)
• documents_indexed: Number of documents indexed. This shows the quantity of documents that were successfully ingested into the Meltwater platform. These documents will appear in results if they match a query.
• status: The status of the batch, which can be one of:
  • pending: The batch is being processed
  • finished: The batch is finished
  • failed: The batch has failed

2. Get Batch Status

Check the status and metrics for a specific batch using its batchId:

GET /byoc/batches/{batchId}

curl -X GET \
--url "https://api.meltwater.com/v3/imports/batches/659d65a6-0937-406a-86da-9d2aa537dfef" \
--header "Accept: application/json" \
--header "apikey: **********"

Example Response

{
   "batch_id": "659d65a6-0937-406a-86da-9d2aa537dfef",
   "created_at": "2025-07-24T12:11:31Z",
   "statistics": {
      "documents_sent": 2,
      "documents_indexed": 2,
      "subgroups": {
         "social": {
            "documents_indexed": 1
         },
         "editorial": {
            "documents_indexed": 1
         }
      }
   },
   "status": "FINISHED"
}