Brandwatch
App · 20 actions
Read Brandwatch Consumer Research queries, mentions, lists and topics; manage tags and categories; watch query and classification changes.
Actions
| Action | What it does |
|---|---|
| Create category | Create category. |
| Create tag | Create tag. |
| Delete category | Delete category. |
| Delete tag | Delete tag. |
| Get current account | Get current account. |
| Get current user | Get current user. |
| Get topics | Get topics. |
| Get total mentions | Get total mentions. |
| Get workflow | Get workflow. |
| List alerts | List alerts. |
| List author lists | List author lists. |
| List categories | List categories. |
| List location lists | List location lists. |
| List mentions | List mentions. |
| List projects | List projects. |
| List queries | List queries. |
| List query groups | List query groups. |
| List rules | List rules. |
| List site lists | List site lists. |
| List tags | List tags. |
Create category
Create category.
Inputs
- Project
project_idtextRequired - Project ID.
- Name
nametextRequired - Name.
- Multiple
multipletrue/false - Multiple.
- Children
childrenlist - 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
- Project
project_idtextRequired - Project ID.
- Name
nametextRequired - 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
- Project
project_idtextRequired - Project ID.
- Category
category_idtextRequired - Category ID.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {}
}Delete tag
Delete tag.
Inputs
- Project
project_idtextRequired - Project ID.
- Tag
tag_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
- Project
project_idtextRequired - Project ID.
- Query
query_idnumberRequired - Query ID.
- Start date
start_datedate and timeRequired - Start date.
- End date
end_datedate and timeRequired - End date.
- Limit
limitnumber - Limit.At least 1.
- Order by
order_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
- Project
project_idtextRequired - Project ID.
- Query
query_idnumberRequired - Query ID.
- Start date
start_datedate and timeRequired - Start date.
- End date
end_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
- Project
project_idtextRequired - Project ID.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"results": []
}
}List alerts
List alerts.
Inputs
- Project
project_idtextRequired - Project ID.
- Page
pagenumber - Page.At least 0.
- Page size
page_sizenumber - Page size.From 1 to 100.
- Enabled
enabledtrue/false - Enabled.
- Owned
ownedtrue/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
- Project
project_idtextRequired - Project ID.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"results": []
}
}List categories
List categories.
Inputs
- Project
project_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
- Project
project_idtextRequired - Project ID.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"results": []
}
}List mentions
List mentions.
Inputs
- Project
project_idtextRequired - Project ID.
- Query
query_idnumberRequired - Query ID.
- Start date
start_datedate and timeRequired - Start date.
- End date
end_datedate and timeRequired - End date.
- Page
pagenumber - Page.At least 0.
- Page size
page_sizenumber - Page size.From 1 to 5000.
- Order direction
order_directiontext - Order direction.One of:
asc,desc. - Sentiment
sentimenttext - Sentiment.One of:
positive,neutral,negative. - Cursor
cursortext - Next cursor from an earlier mention page. This can retrieve beyond the offset pagination limit.
- Since added
since_addeddate and time - Only mentions added to Brandwatch after this time, including older publications.
- Since updated
since_updateddate and time - Only mentions updated in Brandwatch after this time.
- Order by
order_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
- Project
project_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
- Project
project_idtextRequired - Project ID.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"results": []
}
}List rules
List rules.
Inputs
- Project
project_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
- Project
project_idtextRequired - Project ID.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"results": []
}
}List tags
List tags.
Inputs
- Project
project_idtextRequired - Project ID.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"results": []
}
}