For AI agents: visit https://developers.brandwatch.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
Brandwatch Developers
HomeDocsUpdates
SupportMy BrandwatchBrandwatch Developers
Docs
SupportMy Brandwatch
Getting Started

Consumer Research API

  • Getting Started
    • Best practices & our terms
    • Terminology
    • Authentication
    • Rate limiting
  • Users and Clients
    • Retrieving the current User
    • Retrieving the current Client
    • The me call
  • Projects
    • Retrieving Projects
  • Queries
    • Retrieving Queries
    • Creating Queries
    • Editing Queries
    • Deleting Queries
  • Query Groups
    • Retrieving Query Groups
    • Deleting Query Groups
  • Tags
    • Retrieving Tags
    • Creating Tags
    • Deleting Tags
  • Categories
    • Retrieving Categories
    • Creating Categories
    • Deleting Categories
  • Rules
    • Retrieving Rules
    • Deleting Rules
  • Lists
    • Creating Author Lists
    • Retrieving Author Lists
    • Deleting Author Lists
    • Creating Location Lists
    • Retrieving Location Lists
    • Deleting Location Lists
    • Creating Site Lists
    • Retrieving Site Lists
    • Deleting Site Lists
  • Workflow
    • Retrieving Workflow
  • Custom Alerts
    • Retrieving Custom Alerts
    • Creating Custom Alerts
    • Updating Custom Alerts
    • Deleting Custom Alerts
  • Mentions
    • Data Restrictions
    • Mention Field Definitions
    • Retrieving Mentions
    • Retrieving Filtered Mentions
    • Editing Mentions
  • Data Retrieval
    • Total Mentions
    • Topics
    • Topics (New)
    • Basic charts
    • Multiple aggregate charts
    • Chart aggregates and dimensions
    • X (Twitter) Insights
    • Top Sites
    • Top Authors
    • Top X (Twitter) Authors
    • Top Shared Sites
    • Top Shared URLs
  • Filters
    • Available Filters
    • Language Codes
    • Locations
    • Objects & Logos
    • Exclusions
    • Sorting Mentions
  • Tutorials
    • Paging through historical Mentions
    • Polling for Mentions
    • Building a Filters menu

Data Upload API

  • Getting Started
  • Creating a Custom Data Source
  • Retrieving Custom Data Sources
  • Updating Custom Data Sources
  • Uploading Documents
  • Usage Reporting
  • Creating Queries using Custom Data Sources
  • Deleting Data Sources
  • Deleting Documents

Analysis API

  • Getting Started
  • Analysis Request
  • Analysis Results
  • Analysis Usage

Getting Started

Suggest Edits

Here are some resources to help you get started in using the Consumer Research API.

  • Terminology
  • Best practices
  • Authentication
  • Tutorials for common use cases

Updated almost 6 years ago