# Brandwatch

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

App · 20 actions. Web page: https://docs.lodol.com/docs/integrations/brandwatch

## Actions

### Create category

Create category.

**Inputs**

- Project (`project_id`, text, required): Project ID.
- Name (`name`, text, required): Name.
- Multiple (`multiple`, true/false): Multiple.
- Children (`children`, list): Children.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "id": 13,
    "name": "QA category"
  }
}
```

### Create tag

Create tag.

**Inputs**

- Project (`project_id`, text, required): Project ID.
- Name (`name`, text, required): Name.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "id": 12,
    "name": "QA tag"
  }
}
```

### Delete category

Delete category.

**Inputs**

- Project (`project_id`, text, required): Project ID.
- Category (`category_id`, text, required): Category ID.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {}
}
```

### Delete tag

Delete tag.

**Inputs**

- Project (`project_id`, text, required): Project ID.
- Tag (`tag_id`, text, required): Tag ID.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {}
}
```

### Get current account

Get current account.

**Inputs**: None.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "client": {
      "id": 2
    },
    "id": 1
  }
}
```

### Get current user

Get current user.

**Inputs**: None.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "id": 1,
    "username": "qa@example.com"
  }
}
```

### Get topics

Get topics.

**Inputs**

- Project (`project_id`, text, required): Project ID.
- Query (`query_id`, number, required): Query ID.
- Start date (`start_date`, date and time, required): Start date.
- End date (`end_date`, date and time, required): End date.
- Limit (`limit`, number): Limit. At least 1.
- Order by (`order_by`, text): Order by. One of: `burst`, `volume`.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {}
}
```

### Get total mentions

Get total mentions.

**Inputs**

- Project (`project_id`, text, required): Project ID.
- Query (`query_id`, number, required): Query ID.
- Start date (`start_date`, date and time, required): Start date.
- End date (`end_date`, date and time, required): End date.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {}
}
```

### Get workflow

Get workflow.

**Inputs**

- Project (`project_id`, text, required): Project ID.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "results": []
  }
}
```

### List alerts

List alerts.

**Inputs**

- Project (`project_id`, text, required): Project ID.
- Page (`page`, number): Page. At least 0.
- Page size (`page_size`, number): Page size. From 1 to 100.
- Enabled (`enabled`, true/false): Enabled.
- Owned (`owned`, true/false): Owned.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "results": []
  }
}
```

### List author lists

List author lists.

**Inputs**

- Project (`project_id`, text, required): Project ID.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "results": []
  }
}
```

### List categories

List categories.

**Inputs**

- Project (`project_id`, text, required): Project ID.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "results": []
  }
}
```

### List location lists

List location lists.

**Inputs**

- Project (`project_id`, text, required): Project ID.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "results": []
  }
}
```

### List mentions

List mentions.

**Inputs**

- Project (`project_id`, text, required): Project ID.
- Query (`query_id`, number, required): Query ID.
- Start date (`start_date`, date and time, required): Start date.
- End date (`end_date`, date and time, required): End date.
- Page (`page`, number): Page. At least 0.
- Page size (`page_size`, number): Page size. From 1 to 5000.
- Order direction (`order_direction`, text): Order direction. One of: `asc`, `desc`.
- Sentiment (`sentiment`, text): Sentiment. One of: `positive`, `neutral`, `negative`.
- Cursor (`cursor`, text): Next cursor from an earlier mention page. This can retrieve beyond the offset pagination limit.
- Since added (`since_added`, date and time): Only mentions added to Brandwatch after this time, including older publications.
- Since updated (`since_updated`, date and time): Only mentions updated in Brandwatch after this time.
- Order by (`order_by`, text): Sort by publication, addition or update time. One of: `date`, `added`, `updated`.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "results": [],
    "resultsPage": 0,
    "resultsPageSize": 100,
    "resultsTotal": 0
  }
}
```

### List projects

List projects.

**Inputs**: None.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "results": []
  }
}
```

### List queries

List queries.

**Inputs**

- Project (`project_id`, text, required): Project ID.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "results": []
  }
}
```

### List query groups

List query groups.

**Inputs**

- Project (`project_id`, text, required): Project ID.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "results": []
  }
}
```

### List rules

List rules.

**Inputs**

- Project (`project_id`, text, required): Project ID.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "results": []
  }
}
```

### List site lists

List site lists.

**Inputs**

- Project (`project_id`, text, required): Project ID.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "results": []
  }
}
```

### List tags

List tags.

**Inputs**

- Project (`project_id`, text, required): Project ID.

**Outputs**

- `response` (object): The complete service response, including resource data and pagination fields.

**Example output**

```json
{
  "response": {
    "results": []
  }
}
```
