### Data Upload API: Getting Started

Source: https://developers.brandwatch.com/docs/total-mentions

Initial setup guide for the Data Upload API.

```APIDOC
API: Data Upload

Sections:
- Getting Started (/docs/getting-started-data-upload)
```

--------------------------------

### Data Upload API - Getting Started

Source: https://developers.brandwatch.com/docs/top-authors

Guides for getting started with the Data Upload API.

```APIDOC
Data Upload API:

  - Getting Started
```

--------------------------------

### Data Upload API - Getting Started

Source: https://developers.brandwatch.com/docs/top-shared-urls

Guides and initial steps for using the Data Upload API, including authentication and basic setup for custom data sources.

```APIDOC
Data Upload API - Getting Started:
  - Description: Provides an overview of the Data Upload API, including authentication requirements and initial setup procedures for integrating custom data into Brandwatch.
```

--------------------------------

### Data Upload API - Getting Started

Source: https://developers.brandwatch.com/docs/creating-a-custom-data-source

Introduction to the Data Upload API, covering initial setup and concepts.

```APIDOC
Data Upload API - Getting Started:
  - Provides an overview of the Data Upload API functionalities.
```

--------------------------------

### Consumer Research API - Getting Started

Source: https://developers.brandwatch.com/docs/top-authors

Guides for getting started with the Consumer Research API, including best practices, terminology, authentication, and rate limiting.

```APIDOC
Consumer Research API:

Getting Started:
  - Best practices & our terms
  - Terminology
  - Authentication
  - Rate limiting
```

--------------------------------

### Consumer Research API: Getting Started & Authentication

Source: https://developers.brandwatch.com/docs/total-mentions

Guides for initial setup, best practices, terminology, authentication methods, and rate limiting for the Consumer Research API.

```APIDOC
API: Consumer Research

Sections:
- Getting Started (/docs/getting-started)
- Best practices & our terms (/docs/best-practices)
- Terminology (/docs/terminology)
- Authentication (/docs/authenticate)
- Rate limiting (/docs/rate-limiting)
```

--------------------------------

### Data Upload API: Getting Started

Source: https://developers.brandwatch.com/docs/terminology

Introduces the Data Upload API, guiding users on initial setup and requirements for uploading custom data.

```APIDOC
Data Upload API:
  Getting Started
```

--------------------------------

### Data Upload API - Getting Started

Source: https://developers.brandwatch.com/docs/filters

Introduction to the Data Upload API, covering initial setup and usage.

```APIDOC
Data Upload API:
  - Getting Started: Initial steps for using the data upload functionality.
```

--------------------------------

### Data Upload API - Getting Started

Source: https://developers.brandwatch.com/docs/creating-custom-alerts

Introduction to the Data Upload API, covering initial setup and usage.

```APIDOC
Data Upload API:
  - Getting Started
```

--------------------------------

### Data Upload API - Getting Started

Source: https://developers.brandwatch.com/docs/creating-author-lists

Introduction to the Data Upload API, covering initial setup and requirements.

```APIDOC
API Endpoint Group: Data Upload - Getting Started

- /docs/getting-started-data-upload: Initial guide for using the data upload functionality.
```

--------------------------------

### Data Upload API - Getting Started

Source: https://developers.brandwatch.com/docs/languages-and-timezones

Introduction to the Data Upload API, covering initial setup and usage guidelines.

```APIDOC
Data Upload API:
  - Getting Started
```

--------------------------------

### Consumer Research API: Getting Started

Source: https://developers.brandwatch.com/docs/terminology

Provides foundational information for using the Consumer Research API. Includes guides on best practices, terminology, authentication, and rate limiting.

```APIDOC
Consumer Research API:
  Getting Started:
    - Best practices & our terms
    - Terminology
    - Authentication
    - Rate limiting
```

--------------------------------

### Data Upload API - Getting Started and Data Sources

Source: https://developers.brandwatch.com/docs/chart-dimensions-and-aggregates

Covers the initial steps for the Data Upload API, including getting started and managing custom data sources (creation, retrieval, update, deletion).

```APIDOC
Data Upload API:
  Getting Started
  Creating a Custom Data Source
  Retrieving Custom Data Sources
  Updating Custom Data Sources
  Deleting Data Sources
```

--------------------------------

### Data Upload API - Getting Started

Source: https://developers.brandwatch.com/docs/data-retrieval

Provides initial guidance for the Data Upload API, focusing on the process of ingesting custom data into the Brandwatch platform.

```APIDOC
Data Upload API - Getting Started:
  - Getting Started: /docs/getting-started-data-upload
```

--------------------------------

### Data Upload API - Getting Started

Source: https://developers.brandwatch.com/docs/retrieving-custom-data-sources

Introduction to the Data Upload API.

```APIDOC
Data Upload API:
  Getting Started
```

--------------------------------

### Consumer Research API - Getting Started & Core Concepts

Source: https://developers.brandwatch.com/docs/top-subreddits

Provides foundational information for using the Consumer Research API, including getting started guides, best practices, terminology definitions, authentication methods, and rate limiting policies.

```APIDOC
Consumer Research API:
  Getting Started:
    - Overview of API usage and setup.
  Best Practices & Terms:
    - Guidelines for effective and compliant API usage.
  Terminology:
    - Definitions of key terms used within the API.
  Authentication:
    - Methods for authenticating API requests.
  Rate Limiting:
    - Information on API request limits and handling.
```

--------------------------------

### Data Upload API - Getting Started and Data Sources

Source: https://developers.brandwatch.com/docs/basic-charts

Documentation for the Data Upload API, covering initial setup, creating, retrieving, and updating custom data sources.

```APIDOC
API: Data Upload API

Endpoints:
- /docs/getting-started-data-upload: Introduction to the Data Upload API.
- /docs/creating-a-custom-data-source: API call to create a new custom data source.
- /docs/retrieving-custom-data-sources: Fetches existing custom data sources.
- /docs/updating-custom-data-sources: Allows modification of existing custom data sources.
```

--------------------------------

### Consumer Research API - Getting Started & Authentication

Source: https://developers.brandwatch.com/docs/top-shared-sites

Provides foundational information for using the Consumer Research API, including best practices, terminology, authentication methods, and rate limiting policies. Essential for initial setup and understanding API usage constraints.

```APIDOC
Consumer Research API:

Getting Started:
  - Best practices & our terms
  - Terminology
  - Authentication
  - Rate limiting
```

--------------------------------

### Consumer Research API - Getting Started

Source: https://developers.brandwatch.com/docs/creating-a-custom-data-source

Provides foundational information for using the Consumer Research API, including best practices, terminology, authentication methods, and rate limiting policies.

```APIDOC
Consumer Research API - Getting Started:
  - Best practices & our terms: Guidelines for effective and compliant API usage.
  - Terminology: Definitions of key terms used within the API.
  - Authentication: Information on how to authenticate API requests.
  - Rate limiting: Details on API request limits and how to manage them.
```

--------------------------------

### Consumer Research API - Getting Started

Source: https://developers.brandwatch.com/docs/retrieving-custom-data-sources

Provides an overview of the Consumer Research API, including best practices, terminology, authentication, and rate limiting.

```APIDOC
Consumer Research API:
  Getting Started:
    - Best practices & our terms
    - Terminology
    - Authentication
    - Rate limiting
```

--------------------------------

### Consumer Research API - Getting Started & Authentication

Source: https://developers.brandwatch.com/docs/projects

Provides foundational information for using the Consumer Research API, including best practices, terminology, authentication methods, and rate limiting policies. Essential for initial setup and understanding API usage constraints.

```APIDOC
API Section: Consumer Research API

Sub-sections:
- Getting Started
- Best practices & our terms
- Terminology
- Authentication
- Rate limiting

Purpose: To guide users on how to begin using the Consumer Research API, covering essential setup, operational guidelines, and technical constraints.
```

--------------------------------

### Data Upload API - Getting Started

Source: https://developers.brandwatch.com/docs/projects

Introduces the Data Upload API, providing initial guidance for users who need to upload custom data into the Brandwatch platform.

```APIDOC
API Section: Data Upload API

Sub-sections:
- Getting Started

Purpose: To provide initial instructions for using the data upload capabilities.
```

--------------------------------

### Consumer Research API - Getting Started

Source: https://developers.brandwatch.com/docs/creating-custom-alerts

Provides essential information for beginning to use the Consumer Research API, including best practices, terminology, authentication methods, and rate limiting policies.

```APIDOC
Consumer Research API:
  Getting Started:
    - Best practices & our terms
    - Terminology
    - Authentication
    - Rate limiting
```

--------------------------------

### Consumer Research API - Tutorials

Source: https://developers.brandwatch.com/docs/filters

Guides and examples for common API usage patterns, such as paging through mentions, polling for new data, and building filter menus.

```APIDOC
Tutorials:
  - Paging through historical Mentions: Guide on efficiently retrieving large sets of mentions.
  - Polling for Mentions: Instructions on how to check for new mentions periodically.
  - Building a Filters menu: Example of how to construct a dynamic filter interface.
```

--------------------------------

### Consumer Research API - Getting Started

Source: https://developers.brandwatch.com/docs/retrieving-query-groups

Provides foundational information for using the Consumer Research API, including best practices, terminology, authentication methods, and rate limiting policies.

```APIDOC
API: Consumer Research API

Sections:
- Getting Started
  - Best practices & our terms
  - Terminology
  - Authentication
  - Rate limiting
- Users and Clients
  - Projects
  - Queries
  - Query Groups
  - Tags
  - Categories
  - Rules
  - Lists
  - Workflow
  - Custom Alerts
  - Mentions
  - Data Retrieval
  - Filters
  - Tutorials
```

--------------------------------

### Consumer Research API - Getting Started & Authentication

Source: https://developers.brandwatch.com/docs/chart-dimensions-and-aggregates

Provides essential information for starting with the Consumer Research API, including best practices, terminology, authentication methods, and rate limiting policies.

```APIDOC
Consumer Research API:
  Getting Started:
    - Best practices & our terms
    - Terminology
    - Authentication
    - Rate limiting
```

--------------------------------

### Consumer Research API - Getting Started & Core Concepts

Source: https://developers.brandwatch.com/docs/data-retrieval

Provides foundational information for using the Consumer Research API, including best practices, terminology, authentication methods, and rate limiting policies. Essential for initial setup and understanding API usage constraints.

```APIDOC
Consumer Research API:
  - Getting Started: /docs/getting-started
  - Best practices & terms: /docs/best-practices
  - Terminology: /docs/terminology
  - Authentication: /docs/authenticate
  - Rate limiting: /docs/rate-limiting
```

--------------------------------

### Consumer Research API - Getting Started & Authentication

Source: https://developers.brandwatch.com/docs/basic-charts

Provides foundational information for using the Consumer Research API, including best practices, terminology, authentication methods, and rate limiting policies.

```APIDOC
API: Consumer Research

Endpoints:
- /docs/getting-started: General introduction to the API.
- /docs/best-practices: Guidelines for effective API usage.
- /docs/terminology: Definitions of key terms used in the API.
- /docs/authenticate: Details on authentication mechanisms (e.g., API keys, OAuth).
- /docs/rate-limiting: Information on API request limits and policies.
```

--------------------------------

### Consumer Research API - Getting Started & Authentication

Source: https://developers.brandwatch.com/docs/creating-author-lists

Provides foundational information for using the Consumer Research API, including best practices, terminology, authentication methods, and rate limiting policies.

```APIDOC
API Endpoint Group: Getting Started

- /docs/getting-started: Overview of API usage.
- /docs/best-practices: Guidelines for effective API interaction.
- /docs/terminology: Definitions of key terms used in the API.
- /docs/authenticate: Details on authentication mechanisms (e.g., API keys, OAuth).
- /docs/rate-limiting: Information on API request limits and policies.
```

--------------------------------

### Data Upload API: Getting Started and Data Source Management

Source: https://developers.brandwatch.com/docs/twitter-insights

Covers the initial steps for the Data Upload API and managing custom data sources. Includes creating, retrieving, updating, and deleting data sources.

```APIDOC
Data Upload API:

Getting Started:
  - Guide: /docs/getting-started-data-upload
  - Description: Introduction to the Data Upload API.

Creating a Custom Data Source:
  - Endpoint: POST /data-sources
  - Description: Creates a new custom data source.

Retrieving Custom Data Sources:
  - Endpoint: GET /data-sources
  - Description: Lists existing custom data sources.

Updating Custom Data Sources:
  - Endpoint: PUT /data-sources/{id}
  - Description: Modifies an existing custom data source.

Deleting Data Sources:
  - Endpoint: DELETE /data-sources/{id}
  - Description: Removes a custom data source.
```

--------------------------------

### Data Upload API - Getting Started

Source: https://developers.brandwatch.com/docs/mention-metadata-field-definitions

Introduction to the Data Upload API, guiding users on how to get started with uploading custom data.

```APIDOC
Data Upload API:
  Getting Started: /docs/getting-started-data-upload
  Description: Information on initiating data uploads and understanding the process.
```

--------------------------------

### Brandwatch API: Getting Started and Core Concepts

Source: https://developers.brandwatch.com/docs/data-restrictions

Provides essential information for developers starting with the Brandwatch API. Includes guides on best practices, terminology, authentication methods, and rate limiting policies.

```APIDOC
Brandwatch API - Getting Started & Core Concepts:

- Getting Started (/docs/getting-started)
  - Overview of the API and initial setup.
- Best Practices & Terms (/docs/best-practices)
  - Guidelines for efficient and compliant API usage.
- Terminology (/docs/terminology)
  - Definitions of key terms used within the Brandwatch platform and API.
- Authentication (/docs/authenticate)
  - Details on how to authenticate API requests, likely involving API keys or OAuth.
- Rate Limiting (/docs/rate-limiting)
  - Information on API request limits, response codes for exceeding limits, and strategies for managing requests.
```

--------------------------------

### cURL: Fetch Locations by Prefix

Source: https://developers.brandwatch.com/docs/locations

This example demonstrates how to use cURL to make a GET request to the Brandwatch API's locations endpoint. It filters for locations of type 'region' that start with the prefix 'usa'.

```bash
curl -X GET 'https://api.brandwatch.com/locations?type=region&prefix=usa'
```

--------------------------------

### Consumer Research API - Tutorials

Source: https://developers.brandwatch.com/docs/tutorials

Guides for common tasks like paging through mentions, polling for new data, and building filter menus.

```APIDOC
API Reference:

Tutorials

- Paging through historical Mentions: Guide on efficient data retrieval.
- Polling for Mentions: Strategy for fetching new data.
- Building a Filters menu: Example for creating dynamic filter interfaces.
```

--------------------------------

### Consumer Research API: Getting Started & Core Concepts

Source: https://developers.brandwatch.com/docs/twitter-insights

Provides foundational information for using the Consumer Research API, including best practices, terminology, authentication methods, and rate limiting policies. Essential for initial setup and understanding API usage constraints.

```APIDOC
Consumer Research API:

Getting Started:
  - Best practices & our terms
  - Terminology
  - Authentication
  - Rate limiting
```

--------------------------------

### Consumer Research API - Tutorials

Source: https://developers.brandwatch.com/docs/creating-a-custom-data-source

Guides and tutorials for common tasks within the Consumer Research API.

```APIDOC
Tutorials:
  - Paging through historical Mentions: Guide on efficiently retrieving large sets of mentions.
  - Polling for Mentions: Instructions on how to poll for new mentions.
  - Building a Filters menu: A tutorial on creating dynamic filter menus.
```

--------------------------------

### Consumer Research API - Tutorials

Source: https://developers.brandwatch.com/docs/rules

Links to tutorials covering common tasks like paging through mentions, polling for new data, and building filter menus.

```APIDOC
Tutorial: Paging through historical Mentions
  Description: Guide on how to effectively paginate through large datasets of historical mentions using API parameters.

Tutorial: Polling for Mentions
  Description: Instructions on how to implement a polling mechanism to retrieve new mentions as they become available.

Tutorial: Building a Filters menu
  Description: Guidance on using the API to dynamically build user interface elements for filtering mentions.
```

--------------------------------

### Data Upload API - Overview

Source: https://developers.brandwatch.com/docs/retrieving-query-groups

Provides an overview of the Data Upload API, covering getting started and managing custom data sources and documents.

```APIDOC
API: Data Upload API

Sections:
- 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
```

--------------------------------

### Consumer Research API - Tutorials

Source: https://developers.brandwatch.com/docs/tutorial-polling-for-mentions

Links to practical tutorials for common tasks, such as paging through historical mentions, polling for new mentions, and building filter menus. These guides provide step-by-step instructions.

```APIDOC
Consumer Research API - Tutorials:

Paging through historical Mentions:
  - Link: /docs/tutorial-paging-through-historical-mentions
  - Description: Guide on efficiently retrieving large historical datasets.

Polling for Mentions:
  - Link: /docs/tutorial-polling-for-mentions
  - Description: Instructions on how to set up regular checks for new mentions.

Building a Filters menu:
  - Link: /docs/tutorial-building-a-filters-menu
  - Description: Tutorial on creating dynamic filter interfaces.
```

--------------------------------

### Consumer Research API - Tutorials

Source: https://developers.brandwatch.com/docs/top-subreddits

Guides and tutorials for common tasks, such as paging through historical mentions, polling for new mentions, and building filter menus.

```APIDOC
Tutorials:
  Paging through historical Mentions:
    - Guide on efficiently retrieving large sets of historical mention data.
  Polling for Mentions:
    - Instructions on how to set up regular checks for new mention data.
  Building a Filters menu:
    - Steps to create dynamic filter interfaces using API data.
```

--------------------------------

### Data Upload API - Getting Started and Data Sources

Source: https://developers.brandwatch.com/docs/top-shared-sites

Covers the initial steps for the Data Upload API, including creating, retrieving, updating, and deleting custom data sources. This is essential for integrating external data into Brandwatch.

```APIDOC
Data Upload API:

  - Getting Started
  - Creating a Custom Data Source
  - Retrieving Custom Data Sources
  - Updating Custom Data Sources
  - Deleting Data Sources
```

--------------------------------

### Data Upload API - Core Functionality

Source: https://developers.brandwatch.com/docs/tutorial-polling-for-mentions

Documentation for the Data Upload API, covering getting started, creating and managing custom data sources, uploading documents, and usage reporting.

```APIDOC
Data Upload API:

Getting Started:
  - Link: /docs/getting-started-data-upload
  - Description: Initial steps and prerequisites for using the Data Upload API.

Creating a Custom Data Source:
  - Endpoint: POST /data-sources
  - Description: Creates a new custom data source for uploading data.
  - Request Body: Data source configuration.
  - Returns: Created Data Source object.

Retrieving Custom Data Sources:
  - Endpoint: GET /data-sources
  - Description: Fetches a list of existing custom data sources.
  - Returns: Array of Data Source objects.

Updating Custom Data Sources:
  - Endpoint: PUT /data-sources/{sourceId}
  - Description: Modifies an existing custom data source.
  - Request Body: Updated data source configuration.
  - Returns: Updated Data Source object.

Uploading Documents:
  - Endpoint: POST /data-sources/{sourceId}/documents
  - Description: Uploads documents to a specified custom data source.
  - Request Body: Document content and metadata.
  - Returns: Upload status.

Usage Reporting:
  - Endpoint: GET /usage
  - Description: Retrieves information about data upload usage.
  - Returns: Usage statistics.

Creating Queries using Custom Data Sources:
  - Endpoint: POST /queries
  - Description: Creates queries that can utilize custom data sources.
  - Request Body: Query definition including custom data source references.
  - Returns: Created Query object.

Deleting Data Sources:
  - Endpoint: DELETE /data-sources/{sourceId}
  - Description: Removes a custom data source and its associated data.
  - Returns: Success status.

Deleting Documents:
  - Endpoint: DELETE /data-sources/{sourceId}/documents/{documentId}
  - Description: Removes a specific document from a custom data source.
  - Returns: Success status.
```

--------------------------------

### Consumer Research API - Tutorials

Source: https://developers.brandwatch.com/docs/top-authors

Tutorials covering common tasks like paging through historical mentions, polling for mentions, and building filter menus.

```APIDOC
Consumer Research API - Tutorials:

  - Paging through historical Mentions
  - Polling for Mentions
  - Building a Filters menu
```

--------------------------------

### Brandwatch Consumer Research API - Core Concepts

Source: https://developers.brandwatch.com/docs/tags

Provides foundational information for using the Consumer Research API, including getting started, best practices, terminology, authentication, and rate limiting.

```APIDOC
API Section: Getting Started
  - Description: Guides users through initial setup and understanding of the API.
  - Related Topics: Best practices, Terminology, Authentication, Rate limiting.
```

```APIDOC
API Section: Best Practices & Terms
  - Description: Details recommended usage patterns and adherence to Brandwatch's terms of service.
  - Related Topics: Getting Started, Terminology.
```

```APIDOC
API Section: Terminology
  - Description: Defines key terms and concepts used throughout the Brandwatch API documentation.
  - Related Topics: Getting Started, Best Practices.
```

```APIDOC
API Section: Authentication
  - Description: Explains how to authenticate API requests to access Brandwatch data.
  - Related Topics: Getting Started, Rate limiting.
```

```APIDOC
API Section: Rate Limiting
  - Description: Outlines the limits on API request frequency and how to manage them.
  - Related Topics: Getting Started, Authentication.
```

--------------------------------

### Consumer Research API - Tutorials

Source: https://developers.brandwatch.com/docs/creating-author-lists

Guides and tutorials for common API usage patterns, such as paging, polling, and building filter menus.

```APIDOC
API Endpoint Group: Tutorials

- /docs/tutorials: Entry point for tutorials.
- /docs/tutorial-paging-through-historical-mentions: Guide on paginating through large mention datasets.
- /docs/tutorial-polling-for-mentions: Instructions on how to poll for new mentions.
- /docs/tutorial-building-a-filters-menu: Example of constructing a dynamic filters menu using API data.
```

--------------------------------

### Consumer Research API - Getting Started & Authentication

Source: https://developers.brandwatch.com/docs/languages-and-timezones

Provides foundational information for using the Consumer Research API, including best practices, terminology, authentication methods, and rate limiting policies.

```APIDOC
Consumer Research API:
  Getting Started:
    - Best practices & our terms
    - Terminology
    - Authentication
    - Rate limiting
```

--------------------------------

### Consumer Research API - Tutorials

Source: https://developers.brandwatch.com/docs/data-retrieval

Offers guidance through practical use cases, including paging through historical mentions, polling for new mentions, and building a filters menu. These tutorials provide step-by-step instructions for common tasks.

```APIDOC
Tutorials:
  - Paging through historical Mentions: /docs/tutorial-paging-through-historical-mentions
  - Polling for Mentions: /docs/tutorial-polling-for-mentions
  - Building a Filters menu: /docs/tutorial-building-a-filters-menu
```

--------------------------------

### Consumer Research API - Tutorials

Source: https://developers.brandwatch.com/docs/authenticate

Links to tutorials for common tasks in the Brandwatch Consumer Research API, such as paging, polling, and building filter menus.

```APIDOC
Consumer Research API - Tutorials:

Paging through historical Mentions:
  Link: /docs/tutorial-paging-through-historical-mentions
  Description: Guide on how to paginate through historical mention data.

Polling for Mentions:
  Link: /docs/tutorial-polling-for-mentions
  Description: Guide on how to poll for new mentions.

Building a Filters menu:
  Link: /docs/tutorial-building-a-filters-menu
  Description: Guide on how to construct a filters menu.
```