### GET /5.0/pages/details

Source: https://api.brightedge.com/portal/openapi.json

API endpoint for GET /5.0/pages/details

```markdown
### Parameters

- **account_id** (integer, query, required)
- **url** (string, query, required)

### Responses

#### 200 - Successful Response

**PageDetails**
- **url** (string (uri)) (required)
- **canonical_url** (string (uri)) (required)
- **title** (string) (required)
- **meta_description** (string)
- **yearweek** (integer) (required)

#### 422 - Validation Error

**HTTPValidationError**
- **detail** (array (ValidationError))
  Array items:
    - **loc** (array (union)) (required)
    - **msg** (string) (required)
    - **type** (string) (required)

### Example Usage

```bash
curl -X GET "https://api.example.com/5.0/pages/details?account_id=0&url=string"
```

```

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

### GET /5.0/info

Source: https://api.brightedge.com/portal/openapi.json

API endpoint for GET /5.0/info

```markdown
### Responses

#### 200 - Successful Response


### Example Usage

```bash
curl -X GET "https://api.example.com/5.0/info"
```

```

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

### GET /5.0/organizations/objects/recommendations

Source: https://api.brightedge.com/portal/openapi.json

API endpoint for GET /5.0/organizations/objects/recommendations

```markdown
### Parameters

- **time_value** (integer, query, required)
- **time_frequency** (GeogorianTimeTimeStringType, query, required)
- **kwg_name** (array (string), query, optional): Keyword group names to filter recommendations
- **limit** (integer, query, optional)
- **offset** (integer, query, optional)

### Responses

#### 200 - Successful Response

- Array of RecommendationOut

#### 422 - Validation Error

**HTTPValidationError**
- **detail** (array (ValidationError))
  Array items:
    - **loc** (array (union)) (required)
    - **msg** (string) (required)
    - **type** (string) (required)

### Example Usage

```bash
curl -X GET "https://api.example.com/5.0/organizations/objects/recommendations?time_value=0&time_frequency=value&kwg_name=item1,item2&limit=100&offset=0"
```

```

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

### GET /5.0/user_settings/recommendations/{account_id}

Source: https://api.brightedge.com/portal/openapi.json

API endpoint for GET /5.0/user_settings/recommendations/{account_id}

```markdown
### Parameters

- **account_id** (string, path, required)

### Responses

#### 200 - Successful Response


#### 422 - Validation Error

**HTTPValidationError**
- **detail** (array (ValidationError))
  Array items:
    - **loc** (array (union)) (required)
    - **msg** (string) (required)
    - **type** (string) (required)

### Example Usage

```bash
curl -X GET "https://api.example.com/5.0/user_settings/recommendations/{account_id}"
```

```

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

### GET /latest5/info

Source: https://api.brightedge.com/portal/openapi.json

API endpoint for GET /latest5/info

```markdown
### Responses

#### 200 - Successful Response


### Example Usage

```bash
curl -X GET "https://api.example.com/latest5/info"
```

```

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

### GET /latest5/user_settings/recommendations/{account_id}

Source: https://api.brightedge.com/portal/openapi.json

API endpoint for GET /latest5/user_settings/recommendations/{account_id}

```markdown
### Parameters

- **account_id** (string, path, required)

### Responses

#### 200 - Successful Response


#### 422 - Validation Error

**HTTPValidationError**
- **detail** (array (ValidationError))
  Array items:
    - **loc** (array (union)) (required)
    - **msg** (string) (required)
    - **type** (string) (required)

### Example Usage

```bash
curl -X GET "https://api.example.com/latest5/user_settings/recommendations/{account_id}"
```

```

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

### GET /3.0/objects/searchengines/{account_id}

Source: https://api.brightedge.com/portal/openapi.json

API endpoint for GET /3.0/objects/searchengines/{account_id}

```markdown
### Parameters

- **account_id** (integer, path, required)
- **active** (integer, query, optional)

### Responses

#### 200 - Successful Response

**LegacySearchenginesOut**
- **searchengines** (array (LegacySearchenginesShortOut)) (required)
  Array items:
    - **display_name** (string) (required)
    - **country** (string) (required)
    - **searchengine** (string) (required)
    - **location** (string) (required)
    - **device_type** (string) (required)
    - **device_type_id** (string) (required)
    - **searchengine_group_id** (string) (required)
    - **id** (string) (required)

#### 422 - Validation Error

**HTTPValidationError**
- **detail** (array (ValidationError))
  Array items:
    - **loc** (array (union)) (required)
    - **msg** (string) (required)
    - **type** (string) (required)

### Example Usage

```bash
curl -X GET "https://api.example.com/3.0/objects/searchengines/{account_id}?active=0"
```

```

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

### GET /5.0/objects/searchengines/{account_id}

Source: https://api.brightedge.com/portal/openapi.json

API endpoint for GET /5.0/objects/searchengines/{account_id}

```markdown
### Parameters

- **account_id** (integer, path, required)
- **active** (boolean, query, optional)

### Responses

#### 200 - Successful Response

- Array of SearchEngineOut

#### 422 - Validation Error

**HTTPValidationError**
- **detail** (array (ValidationError))
  Array items:
    - **loc** (array (union)) (required)
    - **msg** (string) (required)
    - **type** (string) (required)

### Example Usage

```bash
curl -X GET "https://api.example.com/5.0/objects/searchengines/{account_id}?active=true"
```

```

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

### GET /3.0/objects/datacube_searchengines/{account_id}

Source: https://api.brightedge.com/portal/openapi.json

API endpoint for GET /3.0/objects/datacube_searchengines/{account_id}

```markdown
### Parameters

- **account_id** (integer, path, required)

### Responses

#### 200 - Successful Response

**LegacyDatacubeSearchenginesOut**
- **searchengines** (array (LegacyDatacubeSearchenginesShortOut)) (required)
  Array items:
    - **id** (string) (required)
    - **country** (string) (required)
    - **location** (string) (required)
    - **device_type** (string) (required)
    - **searchengine** (string) (required)
    - **display_name** (string) (required)
    - **device_type_id** (string) (required)
    - **searchengine_group_id** (string) (required)

#### 422 - Validation Error

**HTTPValidationError**
- **detail** (array (ValidationError))
  Array items:
    - **loc** (array (union)) (required)
    - **msg** (string) (required)
    - **type** (string) (required)

### Example Usage

```bash
curl -X GET "https://api.example.com/3.0/objects/datacube_searchengines/{account_id}"
```

```

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

### GET /latest5/jobs/account/{account_id}

Source: https://api.brightedge.com/portal/openapi.json

Get all bulk export jobs for a specific account.

- **account_id**: Account ID to get jobs for

```markdown
### Parameters

- **account_id** (integer, path, required)

### Responses

#### 200 - Successful Response

- Array of BulkExportJobResponse

#### 422 - Validation Error

**HTTPValidationError**
- **detail** (array (ValidationError))
  Array items:
    - **loc** (array (union)) (required)
    - **msg** (string) (required)
    - **type** (string) (required)

### Example Usage

```bash
curl -X GET "https://api.example.com/latest5/jobs/account/{account_id}"
```

```

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

### POST /5.0/jobs

Source: https://api.brightedge.com/portal/openapi.json

Create bulk export job(s) and store them in the database.

- **pod**: Pod number for the job
- **account_id**: Account ID or list of account IDs for the job(s)
- **time_value**: Time value string or list of time values for the export
- **time_cadence**: Time cadence (weekly, monthly, quarterly)
- **query_type**: Type of query to run (keyword_join, keyword_only)
- **user_id**: User ID creating the job
- **path**: Google Cloud Storage path for the export
- **destination**: Destination for export (default: "gcs")
- **device_id**: Device ID filter (default: "*")
- **group_id**: Group ID filter (default: "*")
- **job_id**: Optional batch job ID (auto-generated if not provided)

If multiple account IDs are provided, separate jobs will be created for each account.
If multiple time values are provided, separate jobs will be created for each time value.
The combination of account IDs and time values will create multiple jobs as needed.

```markdown
### Request Body

**Content-Type:** application/json

- **pod** (integer) (required)
- **account_id** (integer) (required)
- **time_value** (string) (required)
- **time_cadence** (string) (required)
- **query_type** (string) (required)
- **user_id** (integer) (required)
- **path** (string) (required)
- **destination** (string)
- **job_id** (string)
- **device_id** (string)
- **group_id** (string)

### Responses

#### 201 - Successful Response

**BulkExportJobCreateResponse**
- **jobs** (array (BulkExportJobResponse)) (required)
  Array items:
    - **id** (string) (required)
    - **job_id** (string) (required)
    - **pod** (integer) (required)
    - **account_id** (integer) (required)
    - **time_value** (string) (required)
    - **time_cadence** (string) (required)
    - **query_type** (string) (required)
    - **user_id** (integer) (required)
    - **status** (integer) (required)
    - **job_create_at** (string (date-time)) (required)
    - **job_start_at** (string (date-time))
    - **job_finish_at** (string (date-time))
    - **job_exception** (string)
    - **path** (string)
    - **retry_count** (integer)
    - **destination** (string)
    - **device_id** (string)
    - **group_id** (string)
- **total_jobs_created** (integer) (required)
- **message** (string) (required)

#### 422 - Validation Error

**HTTPValidationError**
- **detail** (array (ValidationError))
  Array items:
    - **loc** (array (union)) (required)
    - **msg** (string) (required)
    - **type** (string) (required)

### Example Usage

```bash
curl -X POST "https://api.example.com/5.0/jobs" \
  -H "Content-Type: application/json" \
  -d '{
  "pod": "0",
  "account_id": "value",
  "time_value": "value",
  "time_cadence": "string",
  "query_type": "string",
  "user_id": "0",
  "path": "string",
  "destination": "gcs",
  "job_id": "string",
  "device_id": "*",
  "group_id": "*"
}'
```

```

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

### GET /5.0/jobs/account/{account_id}

Source: https://api.brightedge.com/portal/openapi.json

Get all bulk export jobs for a specific account.

- **account_id**: Account ID to get jobs for

```markdown
### Parameters

- **account_id** (integer, path, required)

### Responses

#### 200 - Successful Response

- Array of BulkExportJobResponse

#### 422 - Validation Error

**HTTPValidationError**
- **detail** (array (ValidationError))
  Array items:
    - **loc** (array (union)) (required)
    - **msg** (string) (required)
    - **type** (string) (required)

### Example Usage

```bash
curl -X GET "https://api.example.com/5.0/jobs/account/{account_id}"
```

```

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

### POST /latest5/jobs

Source: https://api.brightedge.com/portal/openapi.json

Create bulk export job(s) and store them in the database.

- **pod**: Pod number for the job
- **account_id**: Account ID or list of account IDs for the job(s)
- **time_value**: Time value string or list of time values for the export
- **time_cadence**: Time cadence (weekly, monthly, quarterly)
- **query_type**: Type of query to run (keyword_join, keyword_only)
- **user_id**: User ID creating the job
- **path**: Google Cloud Storage path for the export
- **destination**: Destination for export (default: "gcs")
- **device_id**: Device ID filter (default: "*")
- **group_id**: Group ID filter (default: "*")
- **job_id**: Optional batch job ID (auto-generated if not provided)

If multiple account IDs are provided, separate jobs will be created for each account.
If multiple time values are provided, separate jobs will be created for each time value.
The combination of account IDs and time values will create multiple jobs as needed.

```markdown
### Request Body

**Content-Type:** application/json

- **pod** (integer) (required)
- **account_id** (integer) (required)
- **time_value** (string) (required)
- **time_cadence** (string) (required)
- **query_type** (string) (required)
- **user_id** (integer) (required)
- **path** (string) (required)
- **destination** (string)
- **job_id** (string)
- **device_id** (string)
- **group_id** (string)

### Responses

#### 201 - Successful Response

**BulkExportJobCreateResponse**
- **jobs** (array (BulkExportJobResponse)) (required)
  Array items:
    - **id** (string) (required)
    - **job_id** (string) (required)
    - **pod** (integer) (required)
    - **account_id** (integer) (required)
    - **time_value** (string) (required)
    - **time_cadence** (string) (required)
    - **query_type** (string) (required)
    - **user_id** (integer) (required)
    - **status** (integer) (required)
    - **job_create_at** (string (date-time)) (required)
    - **job_start_at** (string (date-time))
    - **job_finish_at** (string (date-time))
    - **job_exception** (string)
    - **path** (string)
    - **retry_count** (integer)
    - **destination** (string)
    - **device_id** (string)
    - **group_id** (string)
- **total_jobs_created** (integer) (required)
- **message** (string) (required)

#### 422 - Validation Error

**HTTPValidationError**
- **detail** (array (ValidationError))
  Array items:
    - **loc** (array (union)) (required)
    - **msg** (string) (required)
    - **type** (string) (required)

### Example Usage

```bash
curl -X POST "https://api.example.com/latest5/jobs" \
  -H "Content-Type: application/json" \
  -d '{
  "pod": "0",
  "account_id": "value",
  "time_value": "value",
  "time_cadence": "string",
  "query_type": "string",
  "user_id": "0",
  "path": "string",
  "destination": "gcs",
  "job_id": "string",
  "device_id": "*",
  "group_id": "*"
}'
```

```

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

### GET /latest5/pages/details

Source: https://api.brightedge.com/portal/openapi.json

API endpoint for GET /latest5/pages/details

```markdown
### Parameters

- **account_id** (integer, query, required)
- **url** (string, query, required)

### Responses

#### 200 - Successful Response

**PageDetails**
- **url** (string (uri)) (required)
- **canonical_url** (string (uri)) (required)
- **title** (string) (required)
- **meta_description** (string)
- **yearweek** (integer) (required)

#### 422 - Validation Error

**HTTPValidationError**
- **detail** (array (ValidationError))
  Array items:
    - **loc** (array (union)) (required)
    - **msg** (string) (required)
    - **type** (string) (required)

### Example Usage

```bash
curl -X GET "https://api.example.com/latest5/pages/details?account_id=0&url=string"
```

```

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

### POST /5.0/objects/users/create

Source: https://api.brightedge.com/portal/openapi.json

Create a new user.
Mandatory fields: org_id, account_id, login

```markdown
### Request Body

**Content-Type:** application/json

- **org_id** (integer) (required): Organization ID
- **account_id** (integer) (required): Account ID
- **login** (string (email)) (required): User login/email
- **user_type** (integer): User type
- **role** (integer): User role
- **additional_user_account_id_list** (array (integer)): Additional account IDs for the user
- **first_name** (string): User's first name
- **last_name** (string): User's last name

### Responses

#### 200 - Successful Response

**UserCreateResponse**
- **success** (boolean) (required)
- **message** (string) (required)

#### 422 - Validation Error

**HTTPValidationError**
- **detail** (array (ValidationError))
  Array items:
    - **loc** (array (union)) (required)
    - **msg** (string) (required)
    - **type** (string) (required)

### Example Usage

```bash
curl -X POST "https://api.example.com/5.0/objects/users/create" \
  -H "Content-Type: application/json" \
  -d '{
  "org_id": "0",
  "account_id": "0",
  "login": "user@example.com",
  "user_type": "1",
  "role": "1",
  "additional_user_account_id_list": [
    "0"
  ],
  "first_name": "string",
  "last_name": "string"
}'
```

```

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

### GET /latest5/pages/keywords/primary_secondary

Source: https://api.brightedge.com/portal/openapi.json

API endpoint for GET /latest5/pages/keywords/primary_secondary

```markdown
### Parameters

- **account_id** (integer, query, required)
- **url** (string, query, required)

### Responses

#### 200 - Successful Response

**PSKeywords**
- **primary_keyword** (string)
- **secondary_keywords** (string)

#### 422 - Validation Error

**HTTPValidationError**
- **detail** (array (ValidationError))
  Array items:
    - **loc** (array (union)) (required)
    - **msg** (string) (required)
    - **type** (string) (required)

### Example Usage

```bash
curl -X GET "https://api.example.com/latest5/pages/keywords/primary_secondary?account_id=0&url=string"
```

```

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

### POST /latest5/objects/users/create

Source: https://api.brightedge.com/portal/openapi.json

Create a new user.
Mandatory fields: org_id, account_id, login

```markdown
### Request Body

**Content-Type:** application/json

- **org_id** (integer) (required): Organization ID
- **account_id** (integer) (required): Account ID
- **login** (string (email)) (required): User login/email
- **user_type** (integer): User type
- **role** (integer): User role
- **additional_user_account_id_list** (array (integer)): Additional account IDs for the user
- **first_name** (string): User's first name
- **last_name** (string): User's last name

### Responses

#### 200 - Successful Response

**UserCreateResponse**
- **success** (boolean) (required)
- **message** (string) (required)

#### 422 - Validation Error

**HTTPValidationError**
- **detail** (array (ValidationError))
  Array items:
    - **loc** (array (union)) (required)
    - **msg** (string) (required)
    - **type** (string) (required)

### Example Usage

```bash
curl -X POST "https://api.example.com/latest5/objects/users/create" \
  -H "Content-Type: application/json" \
  -d '{
  "org_id": "0",
  "account_id": "0",
  "login": "user@example.com",
  "user_type": "1",
  "role": "1",
  "additional_user_account_id_list": [
    "0"
  ],
  "first_name": "string",
  "last_name": "string"
}'
```

```

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

### GET /5.0/objects/keywords/{account_id}

Source: https://api.brightedge.com/portal/openapi.json

API endpoint for GET /5.0/objects/keywords/{account_id}

```markdown
### Parameters

- **account_id** (integer, path, required)

### Responses

#### 200 - Successful Response

- Array of KeywordOut

#### 422 - Validation Error

**HTTPValidationError**
- **detail** (array (ValidationError))
  Array items:
    - **loc** (array (union)) (required)
    - **msg** (string) (required)
    - **type** (string) (required)

### Example Usage

```bash
curl -X GET "https://api.example.com/5.0/objects/keywords/{account_id}"
```

```

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

### POST /5.0/productgrid/keywords_with_product_grid_presence

Source: https://api.brightedge.com/portal/openapi.json

API endpoint for POST /5.0/productgrid/keywords_with_product_grid_presence

```markdown
### Request Body

**Content-Type:** application/json

- **account_id** (integer) (required)
- **domain_id** (integer)
- **time_frequency** (string) (required)
- **compare_time_range** (array (integer))
- **search_engine** (array (unknown)) (required): search engine
- **filters** (array (array (union))): filters
- **pagination** (object): Pagination input model.
  - **limit** (integer)
  - **offset** (integer)
- **sort_by** (string): Sort by
- **order** (string): Sort order
- **current_domain_filter** (boolean): Current domain filter
- **is_branded** (boolean): If the query should filter by branded keywords.
- **keyword_groups** (array (integer)): Keyword group
- **presence_filter** (array (integer)): Domain presence filter
- **domain_presence_filter** (array (integer)): Domain presence filter
- **product_grid_presence_filter** (integer): Product grid presence filter
- **time_value** (array (integer))
- **is_lr_enhancement_enabled** (boolean): Enable LR enhancement features
- **page_num** (integer): Fetch result for page1 only

### Responses

#### 200 - Successful Response

**KeywordsWithProductGridPresenceResult**
- **data** (array (KeywordsWithProductGridPresenceItem)) (required)
  Array items:
    - **time** (integer) (required)
    - **product_grid_presence_number** (integer) (required)
    - **clicks** (integer) (required)
    - **search_volume** (integer) (required)
    - **tile_rank** (number) (required)
    - **blended_rank** (number) (required)
    - **keywords_with_domain_presence** (integer) (required)
    - **avg_top_grid_rank** (number) (required)
    - **avg_grid_count** (number) (required)

#### 422 - Validation Error

**HTTPValidationError**
- **detail** (array (ValidationError))
  Array items:
    - **loc** (array (union)) (required)
    - **msg** (string) (required)
    - **type** (string) (required)

### Example Usage

```bash
curl -X POST "https://api.example.com/5.0/productgrid/keywords_with_product_grid_presence" \
  -H "Content-Type: application/json" \
  -d '{
  "account_id": "0",
  "domain_id": "0",
  "time_frequency": "string",
  "compare_time_range": [
    "0"
  ],
  "search_engine": [
    "value"
  ],
  "filters": [
    [
      "value"
    ]
  ],
  "pagination": "value",
  "sort_by": "string",
  "order": "string",
  "current_domain_filter": "true",
  "is_branded": "true",
  "keyword_groups": [
    "0"
  ],
  "presence_filter": [
    "0"
  ],
  "domain_presence_filter": [
    "0"
  ],
  "product_grid_presence_filter": "0",
  "time_value": [
    "0"
  ],
  "is_lr_enhancement_enabled": "false",
  "page_num": "0"
}'
```

```

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

### POST /latest5/productgrid/keywords_with_product_grid_presence

Source: https://api.brightedge.com/portal/openapi.json

API endpoint for POST /latest5/productgrid/keywords_with_product_grid_presence

```markdown
### Request Body

**Content-Type:** application/json

- **account_id** (integer) (required)
- **domain_id** (integer)
- **time_frequency** (string) (required)
- **compare_time_range** (array (integer))
- **search_engine** (array (unknown)) (required): search engine
- **filters** (array (array (union))): filters
- **pagination** (object): Pagination input model.
  - **limit** (integer)
  - **offset** (integer)
- **sort_by** (string): Sort by
- **order** (string): Sort order
- **current_domain_filter** (boolean): Current domain filter
- **is_branded** (boolean): If the query should filter by branded keywords.
- **keyword_groups** (array (integer)): Keyword group
- **presence_filter** (array (integer)): Domain presence filter
- **domain_presence_filter** (array (integer)): Domain presence filter
- **product_grid_presence_filter** (integer): Product grid presence filter
- **time_value** (array (integer))
- **is_lr_enhancement_enabled** (boolean): Enable LR enhancement features
- **page_num** (integer): Fetch result for page1 only

### Responses

#### 200 - Successful Response

**KeywordsWithProductGridPresenceResult**
- **data** (array (KeywordsWithProductGridPresenceItem)) (required)
  Array items:
    - **time** (integer) (required)
    - **product_grid_presence_number** (integer) (required)
    - **clicks** (integer) (required)
    - **search_volume** (integer) (required)
    - **tile_rank** (number) (required)
    - **blended_rank** (number) (required)
    - **keywords_with_domain_presence** (integer) (required)
    - **avg_top_grid_rank** (number) (required)
    - **avg_grid_count** (number) (required)

#### 422 - Validation Error

**HTTPValidationError**
- **detail** (array (ValidationError))
  Array items:
    - **loc** (array (union)) (required)
    - **msg** (string) (required)
    - **type** (string) (required)

### Example Usage

```bash
curl -X POST "https://api.example.com/latest5/productgrid/keywords_with_product_grid_presence" \
  -H "Content-Type: application/json" \
  -d '{
  "account_id": "0",
  "domain_id": "0",
  "time_frequency": "string",
  "compare_time_range": [
    "0"
  ],
  "search_engine": [
    "value"
  ],
  "filters": [
    [
      "value"
    ]
  ],
  "pagination": "value",
  "sort_by": "string",
  "order": "string",
  "current_domain_filter": "true",
  "is_branded": "true",
  "keyword_groups": [
    "0"
  ],
  "presence_filter": [
    "0"
  ],
  "domain_presence_filter": [
    "0"
  ],
  "product_grid_presence_filter": "0",
  "time_value": [
    "0"
  ],
  "is_lr_enhancement_enabled": "false",
  "page_num": "0"
}'
```

```

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

### GET /5.0/pages/keywords/primary_secondary

Source: https://api.brightedge.com/portal/openapi.json

API endpoint for GET /5.0/pages/keywords/primary_secondary

```markdown
### Parameters

- **account_id** (integer, query, required)
- **url** (string, query, required)

### Responses

#### 200 - Successful Response

**PSKeywords**
- **primary_keyword** (string)
- **secondary_keywords** (string)

#### 422 - Validation Error

**HTTPValidationError**
- **detail** (array (ValidationError))
  Array items:
    - **loc** (array (union)) (required)
    - **msg** (string) (required)
    - **type** (string) (required)

### Example Usage

```bash
curl -X GET "https://api.example.com/5.0/pages/keywords/primary_secondary?account_id=0&url=string"
```

```

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

### GET /latest5/objects/aicatalyst/get_all_collectors

Source: https://api.brightedge.com/portal/openapi.json

API endpoint for GET /latest5/objects/aicatalyst/get_all_collectors

```markdown
### Responses

#### 200 - Successful Response

**AICatalystEnabledCollectors**
- **success** (boolean) (required)
- **message** (string) (required)
- **collectors** (array (CollectorInfo)) (required)
  Array items:
    - **collector_id** (integer) (required)
    - **engine_id** (integer) (required)
    - **locale** (string) (required)
    - **location** (string) (required)
    - **language** (string) (required)
    - **engine_name** (string) (required)
    - **status** (integer) (required)

### Example Usage

```bash
curl -X GET "https://api.example.com/latest5/objects/aicatalyst/get_all_collectors"
```

```

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

### POST /latest5/productgrid/info

Source: https://api.brightedge.com/portal/openapi.json

API endpoint for POST /latest5/productgrid/info

```markdown
### Request Body

**Content-Type:** application/json

- **account_id** (integer) (required)

### Responses

#### 200 - Successful Response


#### 422 - Validation Error

**HTTPValidationError**
- **detail** (array (ValidationError))
  Array items:
    - **loc** (array (union)) (required)
    - **msg** (string) (required)
    - **type** (string) (required)

### Example Usage

```bash
curl -X POST "https://api.example.com/latest5/productgrid/info" \
  -H "Content-Type: application/json" \
  -d '{
  "account_id": "0"
}'
```

```

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

### POST /5.0/objects/users/bulk-create

Source: https://api.brightedge.com/portal/openapi.json

API endpoint for POST /5.0/objects/users/bulk-create

```markdown
### Request Body

**Content-Type:** application/json

- **users** (array (CreateUserRequest)) (required)
  Array items:
    - **org_id** (integer) (required): Organization ID
    - **account_id** (integer) (required): Account ID
    - **login** (string (email)) (required): User login/email
    - **user_type** (integer): User type
    - **role** (integer): User role
    - **additional_user_account_id_list** (array (integer)): Additional account IDs for the user
    - **first_name** (string): User's first name
    - **last_name** (string): User's last name

### Responses

#### 200 - Successful Response


#### 422 - Validation Error

**HTTPValidationError**
- **detail** (array (ValidationError))
  Array items:
    - **loc** (array (union)) (required)
    - **msg** (string) (required)
    - **type** (string) (required)

### Example Usage

```bash
curl -X POST "https://api.example.com/5.0/objects/users/bulk-create" \
  -H "Content-Type: application/json" \
  -d '{
  "users": [
    "value"
  ]
}'
```

```

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

### GET /latest5/objects/aicatalyst/accounts

Source: https://api.brightedge.com/portal/openapi.json

API endpoint for GET /latest5/objects/aicatalyst/accounts

```markdown
### Responses

#### 200 - Successful Response

- Array of AICatalystsAccountOut

### Example Usage

```bash
curl -X GET "https://api.example.com/latest5/objects/aicatalyst/accounts"
```

```

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

### POST /5.0/productgrid/info

Source: https://api.brightedge.com/portal/openapi.json

API endpoint for POST /5.0/productgrid/info

```markdown
### Request Body

**Content-Type:** application/json

- **account_id** (integer) (required)

### Responses

#### 200 - Successful Response


#### 422 - Validation Error

**HTTPValidationError**
- **detail** (array (ValidationError))
  Array items:
    - **loc** (array (union)) (required)
    - **msg** (string) (required)
    - **type** (string) (required)

### Example Usage

```bash
curl -X POST "https://api.example.com/5.0/productgrid/info" \
  -H "Content-Type: application/json" \
  -d '{
  "account_id": "0"
}'
```

```

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

### GET /5.0/objects/aicatalyst/get_all_collectors

Source: https://api.brightedge.com/portal/openapi.json

API endpoint for GET /5.0/objects/aicatalyst/get_all_collectors

```markdown
### Responses

#### 200 - Successful Response

**AICatalystEnabledCollectors**
- **success** (boolean) (required)
- **message** (string) (required)
- **collectors** (array (CollectorInfo)) (required)
  Array items:
    - **collector_id** (integer) (required)
    - **engine_id** (integer) (required)
    - **locale** (string) (required)
    - **location** (string) (required)
    - **language** (string) (required)
    - **engine_name** (string) (required)
    - **status** (integer) (required)

### Example Usage

```bash
curl -X GET "https://api.example.com/5.0/objects/aicatalyst/get_all_collectors"
```

```

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

### GET /5.0/objects/aicatalyst/accounts

Source: https://api.brightedge.com/portal/openapi.json

API endpoint for GET /5.0/objects/aicatalyst/accounts

```markdown
### Responses

#### 200 - Successful Response

- Array of AICatalystsAccountOut

### Example Usage

```bash
curl -X GET "https://api.example.com/5.0/objects/aicatalyst/accounts"
```

```

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

### POST /5.0/productgrid/keywords

Source: https://api.brightedge.com/portal/openapi.json

API endpoint for POST /5.0/productgrid/keywords

```markdown
### Request Body

**Content-Type:** application/json

- **account_id** (integer) (required)
- **domain_id** (integer)
- **time_frequency** (string) (required)
- **compare_time_range** (array (integer))
- **search_engine** (array (unknown)) (required): search engine
- **filters** (array (array (union))): filters
- **pagination** (object): Pagination input model.
  - **limit** (integer)
  - **offset** (integer)
- **sort_by** (string): Sort by
- **order** (string): Sort order
- **current_domain_filter** (boolean): Current domain filter
- **is_branded** (boolean): If the query should filter by branded keywords.
- **keyword_groups** (array (integer)): Keyword group
- **presence_filter** (array (integer)): Domain presence filter
- **domain_presence_filter** (array (integer)): Domain presence filter
- **product_grid_presence_filter** (integer): Product grid presence filter
- **time_value** (array (integer))
- **count** (boolean): If the query should count the number of keywords.
- **is_lr_enhancement_enabled** (boolean): Enable LR enhancement features
- **page_num** (integer): Page num 1 results

### Responses

#### 200 - Successful Response

**KeywordMetricsResult**
- **data** (array (KeywordMetricsItem)) (required)
  Array items:
    - **id** (integer) (required)
    - **keyword** (string) (required)
    - **group_titles** (array (string)) (required)
    - **stores** (array (string)) (required)
    - **search_volume** (integer) (required)
    - **search_volume_diff** (integer) (required)
    - **search_volume_diffpercent** (number) (required)
    - **clicks** (integer) (required)
    - **clicks_diff** (integer) (required)
    - **clicks_diffpercent** (number) (required)
    - **blended_rank** (number) (required)
    - **blended_rank_diff** (number) (required)
    - **blended_rank_diffpercent** (number) (required)
    - **tile_rank** (number) (required)
    - **tile_rank_diff** (number) (required)
    - **tile_rank_diffpercent** (number) (required)
    - **domain_presence_product_grids_count** (integer) (required)
    - **total_product_grid_presence_count** (integer) (required)
    - **domain_presence_top_grid_rank** (integer) (required)
    - **domain_presence_top_grid_rank_diff** (integer) (required)
    - **domain_presence_top_grid_rank_prev** (integer) (required)
    - **grid_presence_ratio** (number) (required)
- **total** (integer) (required)
- **branded_keywords** (integer)
- **non_branded_keywords** (integer)

#### 422 - Validation Error

**HTTPValidationError**
- **detail** (array (ValidationError))
  Array items:
    - **loc** (array (union)) (required)
    - **msg** (string) (required)
    - **type** (string) (required)

### Example Usage

```bash
curl -X POST "https://api.example.com/5.0/productgrid/keywords" \
  -H "Content-Type: application/json" \
  -d '{
  "account_id": "0",
  "domain_id": "0",
  "time_frequency": "string",
  "compare_time_range": [
    "0"
  ],
  "search_engine": [
    "value"
  ],
  "filters": [
    [
      "value"
    ]
  ],
  "pagination": "value",
  "sort_by": "string",
  "order": "string",
  "current_domain_filter": "true",
  "is_branded": "true",
  "keyword_groups": [
    "0"
  ],
  "presence_filter": [
    "0"
  ],
  "domain_presence_filter": [
    "0"
  ],
  "product_grid_presence_filter": "0",
  "time_value": [
    "0"
  ],
  "count": "false",
  "is_lr_enhancement_enabled": "false",
  "page_num": "0"
}'
```

```

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

### POST /latest5/productgrid/keywords/export

Source: https://api.brightedge.com/portal/openapi.json

Export keyword metrics data as CSV with specified columns.

```markdown
### Request Body

**Content-Type:** application/json

- **body** (object) (required): Input model for keyword metrics.
  - **account_id** (integer) (required)
  - **domain_id** (integer)
  - **time_frequency** (string) (required)
  - **compare_time_range** (array (integer))
  - **search_engine** (array (unknown)) (required): search engine
  - **filters** (array (array (union))): filters
  - **pagination** (object): Pagination input model.
    - **limit** (integer)
    - **offset** (integer)
  - **sort_by** (string): Sort by
  - **order** (string): Sort order
  - **current_domain_filter** (boolean): Current domain filter
  - **is_branded** (boolean): If the query should filter by branded keywords.
  - **keyword_groups** (array (integer)): Keyword group
  - **presence_filter** (array (integer)): Domain presence filter
  - **domain_presence_filter** (array (integer)): Domain presence filter
  - **product_grid_presence_filter** (integer): Product grid presence filter
  - **time_value** (array (integer))
  - **count** (boolean): If the query should count the number of keywords.
  - **is_lr_enhancement_enabled** (boolean): Enable LR enhancement features
  - **page_num** (integer): Page num 1 results
- **columns** (array (ColumnConfig)) (required)
  Array items:
    - **field** (string) (required)
    - **title** (string) (required)
    - **type** (string) (required)

### Responses

#### 200 - Successful Response


#### 422 - Validation Error

**HTTPValidationError**
- **detail** (array (ValidationError))
  Array items:
    - **loc** (array (union)) (required)
    - **msg** (string) (required)
    - **type** (string) (required)

### Example Usage

```bash
curl -X POST "https://api.example.com/latest5/productgrid/keywords/export" \
  -H "Content-Type: application/json" \
  -d '{
  "body": "value",
  "columns": [
    "value"
  ]
}'
```

```

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

### GET /latest5/dataset/ping

Source: https://api.brightedge.com/portal/openapi.json

API endpoint for GET /latest5/dataset/ping

```markdown
### Responses

#### 200 - Successful Response


### Example Usage

```bash
curl -X GET "https://api.example.com/latest5/dataset/ping"
```

```

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

### GET /5.0/dataset/ping

Source: https://api.brightedge.com/portal/openapi.json

API endpoint for GET /5.0/dataset/ping

```markdown
### Responses

#### 200 - Successful Response


### Example Usage

```bash
curl -X GET "https://api.example.com/5.0/dataset/ping"
```

```

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

### POST /5.0/chrome_extension/overview/content

Source: https://api.brightedge.com/portal/openapi.json

API endpoint for POST /5.0/chrome_extension/overview/content

```markdown
### Request Body

**Content-Type:** application/json

- **account_id** (integer) (required)
- **se_group_id** (integer) (required)
- **url** (string) (required)

### Responses

#### 200 - Successful Response

**Content**
- **word_count** (integer) (required)
- **headings** (object) (required)
  - **H1** (array (string))
  - **H2** (array (string))

#### 422 - Validation Error

**HTTPValidationError**
- **detail** (array (ValidationError))
  Array items:
    - **loc** (array (union)) (required)
    - **msg** (string) (required)
    - **type** (string) (required)

### Example Usage

```bash
curl -X POST "https://api.example.com/5.0/chrome_extension/overview/content" \
  -H "Content-Type: application/json" \
  -d '{
  "account_id": "0",
  "se_group_id": "0",
  "url": "string"
}'
```

```

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

### GET /latest5/marketo/ping

Source: https://api.brightedge.com/portal/openapi.json

API endpoint for GET /latest5/marketo/ping

```markdown
### Responses

#### 200 - Successful Response


### Example Usage

```bash
curl -X GET "https://api.example.com/latest5/marketo/ping"
```

```

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

### POST /latest5/objects/users/bulk-create

Source: https://api.brightedge.com/portal/openapi.json

API endpoint for POST /latest5/objects/users/bulk-create

```markdown
### Request Body

**Content-Type:** application/json

- **users** (array (CreateUserRequest)) (required)
  Array items:
    - **org_id** (integer) (required): Organization ID
    - **account_id** (integer) (required): Account ID
    - **login** (string (email)) (required): User login/email
    - **user_type** (integer): User type
    - **role** (integer): User role
    - **additional_user_account_id_list** (array (integer)): Additional account IDs for the user
    - **first_name** (string): User's first name
    - **last_name** (string): User's last name

### Responses

#### 200 - Successful Response


#### 422 - Validation Error

**HTTPValidationError**
- **detail** (array (ValidationError))
  Array items:
    - **loc** (array (union)) (required)
    - **msg** (string) (required)
    - **type** (string) (required)

### Example Usage

```bash
curl -X POST "https://api.example.com/latest5/objects/users/bulk-create" \
  -H "Content-Type: application/json" \
  -d '{
  "users": [
    "value"
  ]
}'
```

```

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

### GET /5.0/marketo/ping

Source: https://api.brightedge.com/portal/openapi.json

API endpoint for GET /5.0/marketo/ping

```markdown
### Responses

#### 200 - Successful Response


### Example Usage

```bash
curl -X GET "https://api.example.com/5.0/marketo/ping"
```

```