Brandwatch

App · 20 actions

Read Brandwatch Consumer Research queries, mentions, lists and topics; manage tags and categories; watch query and classification changes.

Actions

ActionWhat it does
Create categoryCreate category.
Create tagCreate tag.
Delete categoryDelete category.
Delete tagDelete tag.
Get current accountGet current account.
Get current userGet current user.
Get topicsGet topics.
Get total mentionsGet total mentions.
Get workflowGet workflow.
List alertsList alerts.
List author listsList author lists.
List categoriesList categories.
List location listsList location lists.
List mentionsList mentions.
List projectsList projects.
List queriesList queries.
List query groupsList query groups.
List rulesList rules.
List site listsList site lists.
List tagsList tags.

Create category

Create category.

Inputs

Projectproject_idtextRequired
Project ID.
NamenametextRequired
Name.
Multiplemultipletrue/false
Multiple.
Childrenchildrenlist
Children.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "id": 13,
    "name": "QA category"
  }
}

Create tag

Create tag.

Inputs

Projectproject_idtextRequired
Project ID.
NamenametextRequired
Name.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "id": 12,
    "name": "QA tag"
  }
}

Delete category

Delete category.

Inputs

Projectproject_idtextRequired
Project ID.
Categorycategory_idtextRequired
Category ID.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {}
}

Delete tag

Delete tag.

Inputs

Projectproject_idtextRequired
Project ID.
Tagtag_idtextRequired
Tag ID.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {}
}

Get current account

Get current account.

Inputs

None.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "client": {
      "id": 2
    },
    "id": 1
  }
}

Get current user

Get current user.

Inputs

None.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "id": 1,
    "username": "qa@example.com"
  }
}

Get topics

Get topics.

Inputs

Projectproject_idtextRequired
Project ID.
Queryquery_idnumberRequired
Query ID.
Start datestart_datedate and timeRequired
Start date.
End dateend_datedate and timeRequired
End date.
Limitlimitnumber
Limit.At least 1.
Order byorder_bytext
Order by.One of: burst, volume.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {}
}

Get total mentions

Get total mentions.

Inputs

Projectproject_idtextRequired
Project ID.
Queryquery_idnumberRequired
Query ID.
Start datestart_datedate and timeRequired
Start date.
End dateend_datedate and timeRequired
End date.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {}
}

Get workflow

Get workflow.

Inputs

Projectproject_idtextRequired
Project ID.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "results": []
  }
}

List alerts

List alerts.

Inputs

Projectproject_idtextRequired
Project ID.
Pagepagenumber
Page.At least 0.
Page sizepage_sizenumber
Page size.From 1 to 100.
Enabledenabledtrue/false
Enabled.
Ownedownedtrue/false
Owned.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "results": []
  }
}

List author lists

List author lists.

Inputs

Projectproject_idtextRequired
Project ID.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "results": []
  }
}

List categories

List categories.

Inputs

Projectproject_idtextRequired
Project ID.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "results": []
  }
}

List location lists

List location lists.

Inputs

Projectproject_idtextRequired
Project ID.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "results": []
  }
}

List mentions

List mentions.

Inputs

Projectproject_idtextRequired
Project ID.
Queryquery_idnumberRequired
Query ID.
Start datestart_datedate and timeRequired
Start date.
End dateend_datedate and timeRequired
End date.
Pagepagenumber
Page.At least 0.
Page sizepage_sizenumber
Page size.From 1 to 5000.
Order directionorder_directiontext
Order direction.One of: asc, desc.
Sentimentsentimenttext
Sentiment.One of: positive, neutral, negative.
Cursorcursortext
Next cursor from an earlier mention page. This can retrieve beyond the offset pagination limit.
Since addedsince_addeddate and time
Only mentions added to Brandwatch after this time, including older publications.
Since updatedsince_updateddate and time
Only mentions updated in Brandwatch after this time.
Order byorder_bytext
Sort by publication, addition or update time.One of: date, added, updated.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "results": [],
    "resultsPage": 0,
    "resultsPageSize": 100,
    "resultsTotal": 0
  }
}

List projects

List projects.

Inputs

None.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "results": []
  }
}

List queries

List queries.

Inputs

Projectproject_idtextRequired
Project ID.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "results": []
  }
}

List query groups

List query groups.

Inputs

Projectproject_idtextRequired
Project ID.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "results": []
  }
}

List rules

List rules.

Inputs

Projectproject_idtextRequired
Project ID.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "results": []
  }
}

List site lists

List site lists.

Inputs

Projectproject_idtextRequired
Project ID.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "results": []
  }
}

List tags

List tags.

Inputs

Projectproject_idtextRequired
Project ID.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "results": []
  }
}

On this page