These docs are for v1.0. Click to read the latest docs for v2.0.

Retrieving Queries

Listing the Queries that contain your data.

You can either retrieve all Queries in a given Project, or filter by Query type.

Retrieving all Queries in a Project

The following call will list the Queries in the Project with ID 398748937:
(Click here to learn how to get your Project ID)

curl -X GET https://api.brandwatch.com/projects/398748937/queries/summary

The response will look like the following:

{
  "resultsTotal": 2,
  "resultsPage": -1,
  "resultsPageSize": -1,
  "results": [
    {
      "id": 387238732,
      "name": "@brandwatchsocial",
      "type": "instagram",
      "creationDate": "2016-06-20T19:58:47.675+0000",
      "lastModificationDate": "2016-06-20T19:58:47.682+0000",
      "lastModifiedUsername": "[email protected]",
      "lockedQuery": false,
      "lockedByUsername": null,
      "createdByWizard": false
    },
    {
      "id": 209381723,
      "name": "Mentions of Pepsi",
      "type": "search string",
      "creationDate": "2016-06-07T20:02:07.420+0000",
      "lastModificationDate": "2016-06-07T20:02:53.717+0000",
      "lastModifiedUsername": "[email protected]",
      "lockedQuery": false,
      "lockedByUsername": null,
      "createdByWizard": false
    }
  ]
}

You can then use the id of the Query to apply a Filter to Mentions data calls, or to create charts with.

Retrieving Queries Filtered by Type

You can determine whether a Query is a standard Brandwatch Query or a Channel by the type field:

  • search string - A Brandwatch query created by the Query Wizard, or by Boolean search string.
  • twitter - A Twitter Channel.
  • facebook - A Facebook Channel.
  • instagram - An Instagram Channel.

If you wish to only retrieve a particular type of Query, then you can pass the type as a parameter.

The following call will list the Instagram Channels in the Project with ID 398748937:
(Click here to learn how to get your Project ID)

curl -X GET https://api.brandwatch.com/projects/398748937/queries?type=instagram