Objects & Logos

In order to filter by specific image objects or logos when creating a new Query, you must first make a call to retrieve the specific image object/logo IDs.

Pagination

Parameter

Definition

Accepted Values

pageSize

The number of objects/logos on each page of the response.

An integer from 1-5000

page

The page to retrieve, indexed from 0.

An integer, index starting at 0.

Image Objects

The following example call returns a list of all possible image objects:

curl -X GET 'https://api.brandwatch.com/projects/1998283571/images/objects?pageSize=1000&page=0'

And the response looks like this, where the id is what you need to include when you create a new Query:

{
    "resultsTotal": 1199,
    "resultsPage": 0,
    "resultsPageSize": 20,
    "results": [
        {
            "id": 3164,
            "name": "abbey",
            "type": "object",
            "active": true,
            "version": 0
        },
        {
            "id": 3469,
            "name": "acrobatics",
            "type": "action",
            "active": true,
            "version": 0
        }
    ]
}

Logos

The following example call returns a list of all possible logos available in your project:

curl -X GET 'https://api.brandwatch.com/projects/1998283571/images/logos?pageSize=1000&page=0'

And the response looks something like this, where id is what you need to include when you create a new Query:

{
    "resultsTotal": 764,
    "resultsPage": 0,
    "resultsPageSize": 20,
    "results": [
        {
            "id": 12345,
            "name": "Coca-Cola",
            "alias": "Coca-Cola",
            "active": true,
            "version": 0,
            "logoVersions": [
                "https://s3-eu-west-1.amazonaws.com/s3.logograb.com/logograb/cache-dir-public/2c2ddaabbe03b4e888ff580d1750fbd83e46e.png",
                "https://s3-eu-west-1.amazonaws.com/s3.logograb.com/logograb/cache-dir-public/6a532f640016d045fa8a97f82e6c89ac89c9.png",
                "https://s3-eu-west-1.amazonaws.com/s3.logograb.com/logograb/cache-dir-public/6e4ba252b4436f93e5c3a2e22d6600911cb.png"
            ],
            "private": false
        },
        {
            "id": 123,
            "name": "Pepsi",
            "alias": "Pepsi",
            "active": true,
            "version": 0,
            "logoVersions": [
                "https://s3-eu-west-1.amazonaws.com/s3.logograb.com/logograb/cache-dir-public/e97267794c82d16b49b6b914f526d30e996a.png"
            ],
            "private": false
        }
    ]
}