### Create Project API Request Example

Source: https://api-data.brand24.com/api-data-docs/documentation/index

This example demonstrates a POST request to create a project using the Brand24 API. It includes the endpoint URL with account ID, project name, and language as query parameters, and a JSON payload defining keywords. The response indicates success or failure.

```http
POST /api-data/v1/account/{account_id}/create_project?project_name={project_name}&language={language} HTTP/1.1
Host: api-data.brand24.com
Content-Type: application/json

{
  "keywords": [
    {
      "keyword": "asus"
    },
    {
      "keyword": "sony",
      "excluded": [
        "headphones",
        "tv",
        "playstation"
      ]
    },
    {
      "keyword": "logitech",
      "required": [
        "keyboard"
      ],
      "excluded": [
        "mouse"
      ]
    }
  ]
}
```

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

### Get Project List API Request Example

Source: https://api-data.brand24.com/api-data-docs/documentation/index

This example shows a GET request to retrieve a list of projects associated with a specific account ID in the Brand24 API. It requires an account ID in the path and an API key for authorization. The response includes a list of project names and their corresponding IDs.

```http
GET /api-data/v1/account/{account_id}/projects_list/ HTTP/1.1
Host: api-data.brand24.com
X-Api-Key: YOUR_API_KEY
```

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

### Get Reach Statistics - API Request Example

Source: https://api-data.brand24.com/api-data-docs/documentation/index

This API request retrieves reach statistics for a project over a specified date range. It requires the project ID and the start and end dates, with a maximum range of one month.

```HTTP
GET https://api-data.brand24.com/api-data/v1/project/{project_id}/mentions/reach?date_from={date_from}&date_to={date_to} 
Host: api-data.brand24.com
Authorization: X-Api-Key YOUR_API_KEY
```

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

### Create Project - API Request Example (Partial)

Source: https://api-data.brand24.com/api-data-docs/documentation/index

This snippet illustrates the beginning of an API request to create a new project. It requires an account ID and can include parameters to filter mentions by keywords, language, and specific word inclusions or exclusions.

```HTTP
POST https://api-data.brand24.com/api-data/v1/account/{account_id}/project 
Host: api-data.brand24.com
Authorization: X-Api-Key YOUR_API_KEY
Content-Type: application/json

{
  "name": "My New Project",
  "keywords": [
    {
      "keyword": "example",
      "required": "specific",
      "excluded": "irrelevant"
    }
  ],
  "language": "en"
}
```

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

### Get Mentions Sentiment - API Request Example

Source: https://api-data.brand24.com/api-data-docs/documentation/index

This snippet shows how to request sentiment analysis for mentions within a project and date range. Similar to mentions count, it requires project ID, start date, and end date, with a maximum date range of one month.

```HTTP
GET https://api-data.brand24.com/api-data/v1/project/{project_id}/mentions/sentiment?date_from={date_from}&date_to={date_to} 
Host: api-data.brand24.com
Authorization: X-Api-Key YOUR_API_KEY
```

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

### Get Mentions Count - API Request Example

Source: https://api-data.brand24.com/api-data-docs/documentation/index

This snippet demonstrates how to make an API request to retrieve the number of mentions for a specific project within a given date range. It requires the project ID, start date, and end date as parameters. The maximum allowed range between dates is one month.

```HTTP
GET https://api-data.brand24.com/api-data/v1/project/{project_id}/mentions/count?date_from={date_from}&date_to={date_to} 
Host: api-data.brand24.com
Authorization: X-Api-Key YOUR_API_KEY
```

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

### GET /api-data/v1/account/{account_id}/projects_list

Source: https://api-data.brand24.com/api-data-docs/documentation/index

Retrieves a list of all projects within your Brand24 account, including their names and IDs.

```APIDOC
## GET /api-data/v1/account/{account_id}/projects_list

### Description
Retrieves a list of all projects within your Brand24 account, including their names and IDs.

### Method
GET

### Endpoint
`/api-data/v1/account/{account_id}/projects_list/`

### Parameters
#### Path Parameters
- **account_id** (integer) - Required - ID of your account

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation.
- **data** (object) - Contains the list of projects.
  - **projects_list** (object) - A key-value pair where the key is the project ID and the value is the project name.

#### Response Example
```json
{
  "status": "success",
  "data": {
    "projects_list": {
      "123456789": "project name 1",
      "234567891": "project name 2"
    }
  }
}
```

### Error Responses
- **400**: Bad request
- **401**: Unauthorised
- **404**: Invalid endpoint url address
- **500**: General/unhandled error
```

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

### Reach Statistics - JSON Response Example

Source: https://api-data.brand24.com/api-data-docs/documentation/index

This JSON response provides reach statistics for a project. It includes daily counts and totals for both social media reach and non-social media reach within the requested period.

```JSON
{
  "status": "success",
  "data": {
    "social_media_reach": {
      "2022-01-01": 12,
      "2022-01-02": 26,
      "2022-01-03": 9
    },
    "social_media_reach_total": 47,
    "non_social_media_reach": {
      "2022-01-01": 37,
      "2022-01-02": 39,
      "2022-01-03": 24
    },
    "non_social_media_reach_total": 100
  }
}
```

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

### Mentions Sentiment - JSON Response Example

Source: https://api-data.brand24.com/api-data-docs/documentation/index

This JSON represents a successful response from the Mentions Sentiment API. It details the counts of mentions (overall, positive, and negative) per day and their respective totals within the queried period.

```JSON
{
  "status": "success",
  "data": {
    "mentions": {
      "2022-01-01": 3451,
      "2022-01-02": 1456,
      "2022-01-03": 6743
    },
    "total_mentions": 11650,
    "positive_mentions": {
      "2022-01-01": 467,
      "2022-01-02": 241,
      "2022-01-03": 1890
    },
    "total_positive_mentions": 2598,
    "negative_mentions": {
      "2022-01-01": 756,
      "2022-01-02": 436,
      "2022-01-03": 1100
    },
    "total_negative_results": 2292
  }
}
```

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

### Mentions Count - JSON Response Example

Source: https://api-data.brand24.com/api-data-docs/documentation/index

This is a sample JSON response for the Mentions Count API endpoint. It includes the status of the operation and a 'data' object containing the count of mentions for each day within the specified range and the total mentions.

```JSON
{
  "status": "success",
  "data": {
    "mentions_count": {
      "2022-01-01": 37,
      "2022-01-02": 12,
      "2022-01-03": 53,
      "2022-01-04": 7,
      "2022-01-05": 109,
      "2022-01-06": 19,
      "2022-01-07": 78
    },
    "total": 315
  }
}
```

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

### Get Project List Success Response

Source: https://api-data.brand24.com/api-data-docs/documentation/index

This JSON object represents a successful response from the Brand24 API when requesting a list of projects. It includes a status field and a data object containing a mapping of project IDs to their names.

```json
{
  "status": "success",
  "data": {
    "projects_list": {
      "123456789": "project name 1",
      "234567891": "project name 2"
    }
  }
}
```

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

### Create Project API

Source: https://api-data.brand24.com/api-data-docs/documentation/index

Allows the creation of a new project to collect mentions. Projects can be configured with keywords, required/excluded words, and specific languages.

```APIDOC
## POST /api-data/v1/projects

### Description
We will collect mentions containing given keywords. You can create a project with one or more keywords. If you want to narrow the mentions, for every keyword you can provide one or more optional "required" or "excluded" word. If you want to collect mentions in specific language, you can provide language parameter. You can provide only one language. If you don't provide language parameter, we will collect mentions in any language.

### Method
POST

### Endpoint
`/api-data/v1/projects`

### Parameters
#### Path Parameters
- **account** (integer) - Required - Your account ID

#### Request Body
*(Details for request body fields such as keywords, required/excluded words, and language are not fully provided in the input text and would typically be detailed here.)*

### Request Example
*(A full request example for project creation is not provided in the input text.)*

### Response
*(Response details for project creation are not provided in the input text.)*
```

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

### POST /api-data/v1/account/{account_id}/create_project

Source: https://api-data.brand24.com/api-data-docs/documentation/index

Creates a new project within your Brand24 account. You can specify keywords to track, including required and excluded terms.

```APIDOC
## POST /api-data/v1/account/{account_id}/create_project

### Description
Creates a new project within your Brand24 account. You can specify keywords to track, including required and excluded terms.

### Method
POST

### Endpoint
`/api-data/v1/account/{account_id}/create_project`

### Parameters
#### Path Parameters
- **account_id** (integer) - Required - ID of your account

#### Query Parameters
- **project_name** (string) - Required - Name of your project
- **language** (string) - Optional - If not provided, mentions in any language will be collected. Available languages: english, spanish, arabic, croatian, czech, danish, dutch, finnish, french, german, hungarian, indonesian, italian, korean, norwegian, polish, portuguese, romanian, russian, slovak, swedish, thai, turkish, vietnamese.

#### Request Body
- **keywords** (Array of objects) - Required - An object representing keywords with required and excluded items.
  - **keyword** (string) - Required - The keyword to track.
  - **required** (Array of strings) - Optional - List of terms that must be present along with the keyword.
  - **excluded** (Array of strings) - Optional - List of terms to exclude from the search results.

### Request Example
```json
{
  "keywords": [
    {
      "keyword": "asus"
    },
    {
      "keyword": "sony",
      "excluded": [
        "headphones",
        "tv",
        "playstation"
      ]
    },
    {
      "keyword": "logitech",
      "required": [
        "keyboard"
      ],
      "excluded": [
        "mouse"
      ]
    }
  ]
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation.
- **data** (object) - Contains project creation details.
  - **projectId** (integer) - The ID of the newly created project.

#### Response Example
```json
{
  "status": "success",
  "data": {
    "projectId": 0
  }
}
```

### Error Responses
- **400**: Bad request
- **401**: Unauthorised
- **404**: Invalid endpoint url address
- **500**: General/unhandled error
```

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

### Create Project Payload

Source: https://api-data.brand24.com/api-data-docs/documentation/index

This is a JSON payload for creating a new project in Brand24. It specifies keywords to track, including required and excluded terms to refine the search. The structure allows for complex keyword configurations.

```json
{
  "keywords": [
    {
      "keyword": "asus"
    },
    {
      "keyword": "sony",
      "excluded": [
        "headphones",
        "tv",
        "playstation"
      ]
    },
    {
      "keyword": "logitech",
      "required": [
        "keyboard"
      ],
      "excluded": [
        "mouse"
      ]
    }
  ]
}
```

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

### Create Project Success Response

Source: https://api-data.brand24.com/api-data-docs/documentation/index

This JSON object represents a successful response from the Brand24 API after creating a project. It contains a status field indicating success and a data object with the newly created project's ID.

```json
{
  "status": "success",
  "data": {
    "projectId": 0
  }
}
```

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

### Reach API

Source: https://api-data.brand24.com/api-data-docs/documentation/index

Retrieves reach statistics for a given project and date range. The maximum allowed date range is 1 month.

```APIDOC
## GET /api-data/v1/project/{project_id}/mentions/reach

### Description
Get reach statistics for given project and date range. The maximum allowed range between date parameters is 1 month.

### Method
GET

### Endpoint
`/api-data/v1/project/{project_id}/mentions/reach?date_from={date_from}&date_to={date_to}`

### Parameters
#### Path Parameters
- **project_id** (integer) - Required - ID of your project

#### Query Parameters
- **date_from** (string) - Required - Start of data range, allowed date format: YYYY-MM-DD
- **date_to** (string) - Required - End of data range, allowed date format: YYYY-MM-DD

### Request Example
```json
{
  "example": "GET /api-data/v1/project/123456789/mentions/reach?date_from=2022-06-01&date_to=2022-06-30"
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the operation.
- **data** (object) - Contains the reach data.
  - **social_media_reach** (object) - An object where keys are dates and values are the social media reach for that date.
  - **social_media_reach_total** (integer) - The total social media reach.
  - **non_social_media_reach** (object) - An object where keys are dates and values are the non-social media reach for that date.
  - **non_social_media_reach_total** (integer) - The total non-social media reach.

#### Response Example
```json
{
  "status": "success",
  "data": {
    "social_media_reach": {
      "2022-01-01": 12,
      "2022-01-02": 26,
      "2022-01-03": 9
    },
    "social_media_reach_total": 47,
    "non_social_media_reach": {
      "2022-01-01": 37,
      "2022-01-02": 39,
      "2022-01-03": 24
    },
    "non_social_media_reach_total": 100
  }
}
```
```

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

### Mentions Count API

Source: https://api-data.brand24.com/api-data-docs/documentation/index

Retrieves the number of mentions for a given project within a specified date range. The maximum allowed date range is 1 month.

```APIDOC
## GET /api-data/v1/project/{project_id}/mentions/count

### Description
Get number of mentions for given project and date range. The maximum allowed range between date parameters is 1 month.

### Method
GET

### Endpoint
`/api-data/v1/project/{project_id}/mentions/count?date_from={date_from}&date_to={date_to}`

### Parameters
#### Path Parameters
- **project_id** (integer) - Required - ID of your project

#### Query Parameters
- **date_from** (string) - Required - Start of data range, allowed date format: YYYY-MM-DD
- **date_to** (string) - Required - End of data range, allowed date format: YYYY-MM-DD

### Request Example
```json
{
  "example": "GET /api-data/v1/project/123456/mentions/count?date_from=2022-05-01&date_to=2022-05-31"
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the operation.
- **data** (object) - Contains the mentions count data.
  - **mentions_count** (object) - An object where keys are dates and values are the count of mentions for that date.
  - **total** (integer) - The total number of mentions within the specified date range.

#### Response Example
```json
{
  "status": "success",
  "data": {
    "mentions_count": {
      "2022-01-01": 37,
      "2022-01-02": 12,
      "2022-01-03": 53,
      "2022-01-04": 7,
      "2022-01-05": 109,
      "2022-01-06": 19,
      "2022-01-07": 78
    },
    "total": 315
  }
}
```
```

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

### Sentiment API

Source: https://api-data.brand24.com/api-data-docs/documentation/index

Retrieves the sentiment analysis of mentions for a given project and date range. The maximum allowed date range is 1 month.

```APIDOC
## GET /api-data/v1/project/{project_id}/mentions/sentiment

### Description
Get number of mentions with sentiment for given project and date range. The maximum allowed range between date parameters is 1 month.

### Method
GET

### Endpoint
`/api-data/v1/project/{project_id}/mentions/sentiment?date_from={date_from}&date_to={date_to}`

### Parameters
#### Path Parameters
- **project_id** (integer) - Required - ID of your project

#### Query Parameters
- **date_from** (string) - Required - Start of data range, allowed date format: YYYY-MM-DD
- **date_to** (string) - Required - End of data range, allowed date format: YYYY-MM-DD

### Request Example
```json
{
  "example": "GET /api-data/v1/project/123456789/mentions/sentiment?date_from=2022-06-01&date_to=2022-06-30"
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the operation.
- **data** (object) - Contains the sentiment data.
  - **mentions** (object) - An object where keys are dates and values are the total count of mentions for that date.
  - **total_mentions** (integer) - The total number of mentions within the specified date range.
  - **positive_mentions** (object) - An object where keys are dates and values are the count of positive mentions for that date.
  - **total_positive_mentions** (integer) - The total count of positive mentions.
  - **negative_mentions** (object) - An object where keys are dates and values are the count of negative mentions for that date.
  - **total_negative_results** (integer) - The total count of negative mentions.

#### Response Example
```json
{
  "status": "success",
  "data": {
    "mentions": {
      "2022-01-01": 3451,
      "2022-01-02": 1456,
      "2022-01-03": 6743
    },
    "total_mentions": 11650,
    "positive_mentions": {
      "2022-01-01": 467,
      "2022-01-02": 241,
      "2022-01-03": 1890
    },
    "total_positive_mentions": 2598,
    "negative_mentions": {
      "2022-01-01": 756,
      "2022-01-02": 436,
      "2022-01-03": 1100
    },
    "total_negative_results": 2292
  }
}
```
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.