# brandwatch OpenAPI overview

> Below is an overview of the brandwatch openapi in simple language. This API contains 24 endpoints.

For more detailed information of an endpoint, visit https://oapis.org/summary/brandwatch/[idOrRoute]

Brandwatch Consumer Research API v1.5.1 - https://api.brandwatch.com
API for interacting with Brandwatch Consumer Research projects

## Authentication

- [getToken](https://oapis.org/openapi/brandwatch/getToken): POST https://api.brandwatch.com/oauth/token - Authenticate and get access token

## Author Lists

- [createAuthorList](https://oapis.org/openapi/brandwatch/createAuthorList): POST https://api.brandwatch.com/projects/{projectId}/group/author - Create a new author list

## Categories

- [createCategory](https://oapis.org/openapi/brandwatch/createCategory): POST https://api.brandwatch.com/projects/{projectId}/rulecategories - Create a new category

## Location Lists

- [createLocationList](https://oapis.org/openapi/brandwatch/createLocationList): POST https://api.brandwatch.com/projects/{projectId}/group/location - Create a new location list

## Mentions

- [getMentions](https://oapis.org/openapi/brandwatch/getMentions): GET https://api.brandwatch.com/projects/{projectId}/data/mentions?queryId=integer&startDate=string&endDate=string - Get mentions for a query or group
- [updateMentions](https://oapis.org/openapi/brandwatch/updateMentions): PATCH https://api.brandwatch.com/projects/{projectId}/data/mentions - Update mentions
- [getMentionCount](https://oapis.org/openapi/brandwatch/getMentionCount): GET https://api.brandwatch.com/projects/{projectId}/data/mentions/count?queryId=integer&startDate=string&endDate=string - Get mention count for a query or group

## Projects

- [getProjects](https://oapis.org/openapi/brandwatch/getProjects): GET https://api.brandwatch.com/projects - Get all projects

## Queries

- [getQueries](https://oapis.org/openapi/brandwatch/getQueries): GET https://api.brandwatch.com/projects/{projectId}/queries - Get all queries in a project
- [createQuery](https://oapis.org/openapi/brandwatch/createQuery): POST https://api.brandwatch.com/projects/{projectId}/queries - Create a new query
- [getQuery](https://oapis.org/openapi/brandwatch/getQuery): GET https://api.brandwatch.com/projects/{projectId}/queries/{queryId} - Get a specific query
- [updateQuery](https://oapis.org/openapi/brandwatch/updateQuery): PUT https://api.brandwatch.com/projects/{projectId}/queries/{queryId} - Update a query
- [deleteQuery](https://oapis.org/openapi/brandwatch/deleteQuery): DELETE https://api.brandwatch.com/projects/{projectId}/queries/{queryId} - Delete a query

## Query Groups

- [getQueryGroups](https://oapis.org/openapi/brandwatch/getQueryGroups): GET https://api.brandwatch.com/projects/{projectId}/querygroups - Get all query groups in a project
- [createQueryGroup](https://oapis.org/openapi/brandwatch/createQueryGroup): POST https://api.brandwatch.com/projects/{projectId}/querygroups - Create a new query group

## Query Validation

- [validateQuerySearch](https://oapis.org/openapi/brandwatch/validateQuerySearch): POST https://api.brandwatch.com/query-validation - Validate a query search

## Rules

- [getRules](https://oapis.org/openapi/brandwatch/getRules): GET https://api.brandwatch.com/projects/{projectId}/rules - Get all rules in a project
- [createRule](https://oapis.org/openapi/brandwatch/createRule): POST https://api.brandwatch.com/projects/{projectId}/rules - Create a new rule

## Signals

- [createSignalGroup](https://oapis.org/openapi/brandwatch/createSignalGroup): POST https://api.brandwatch.com/projects/{projectId}/signals/groups - Create a new signal group

## Site Lists

- [createSiteList](https://oapis.org/openapi/brandwatch/createSiteList): POST https://api.brandwatch.com/projects/{projectId}/group/site - Create a new site list

## Tags

- [getTags](https://oapis.org/openapi/brandwatch/getTags): GET https://api.brandwatch.com/projects/{projectId}/ruletags - Get all tags in a project
- [createTag](https://oapis.org/openapi/brandwatch/createTag): POST https://api.brandwatch.com/projects/{projectId}/ruletags - Create a new tag

## Topics

- [getTopics](https://oapis.org/openapi/brandwatch/getTopics): GET https://api.brandwatch.com/projects/{projectId}/data/volume/topics/queries?queryId=integer&startDate=string&endDate=string - Get topics for a query or group

## User

- [getSelf](https://oapis.org/openapi/brandwatch/getSelf): GET https://api.brandwatch.com/me - Get current user information