Usage Reporting

You are limited to uploading 1,000 documents per request. The uploadCount value in the JSON response represents the number of documents you've just uploaded.

There is also a limit to how many documents can be uploaded in a 30 day/24 hour period. There two options to monitor usage:

Usage reporting in upload request response

We’ve included an extra JSON property requestUsage: True when making the request to upload documents to trigger extra fields in the response when you are finished uploading documents. Here is an example:

curl -X POST 'https://api.brandwatch.com/content/upload' \
-H 'authorization: bearer xxxxxx-xxxxxx-xxxxxx-xxxxxx-xxxx' \
-H 'Content-Type: application/json' \
-d '
{
  "items": [
    {
      "guid": "3d101fd9b2004a11a76ba1ea637eb9f2",
      "gelocation": {
        "id": "USA.fl"
      },
      "date": "2020-03-25T15:04:00",
      "contents": "testing the data upload API..again",
      "custom": {
        "myfield": "testmetric"
      }
    }
  ],
  "contentSource": 34354220140,
  "requestUsage": true
}'

And the response looks like this:

{
        "uploadCount": "...",
        "batch": "...",
        "monthlyDocumentsUploaded": 501,
        "monthlyDocumentsUploadLimit": 1000
}

Usage reporting endpoint

In addition to requesting usage numbers with the upload request, there is also a dedicated endpoint to retrieve usage numbers. This can be useful if you want to confirm there is enough spare upload capacity before actually uploading documents. Here is an example call:

curl -x GET 'https://api.brandwatch.com/content/upload/usage' \
-H 'authorization: bearer xxxxxx-xxxxxx-xxxxxx-xxxxxx-xxxx' \

And the response looks like this:

{
  "monthlyDocumentsUploaded": 0,
  "monthlyDocumentsUploadLimit": 1000
}