BrightEdge Technologies product_grid API
APIs for product grid
APIs for product grid
openapi: 3.1.0
info:
title: BrightEdge Platform accounts product_grid API
description: This API provides the ability to integrate with BrightEdge Platform
version: 5.0.0
tags:
- name: product_grid
description: APIs for product grid
paths:
/5.0/productgrid/info:
post:
tags:
- product_grid
summary: Test
operationId: info_5_0_productgrid_info_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AccountInputModel'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
/5.0/productgrid/keywords:
post:
tags:
- product_grid
summary: Get keyword metrics data
operationId: get_keyword_metrics_5_0_productgrid_keywords_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/KeywordsMetricsInputModel'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/KeywordMetricsResult'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
/5.0/productgrid/keyword_groups:
post:
tags:
- product_grid
summary: Get keyword group metrics data
operationId: get_keyword_group_metrics_5_0_productgrid_keyword_groups_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/KeywordGroupMetricsInputModel'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/KeywordGroupMetricsResult'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
/5.0/productgrid/top_sellers/trend_chart:
post:
tags:
- product_grid
summary: Get keyword top sellers trend chart
description: Get top sellers trend chart data for a given account and time range.
operationId: get_top_sellers_trend_chart_5_0_productgrid_top_sellers_trend_chart_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TopSellersTrendChartInputModel'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/TopSellersTrendChartResult'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
/5.0/productgrid/presence/trend_chart:
post:
tags:
- product_grid
summary: Get presence breakdown info
operationId: get_product_grid_presence_trend_chart_5_0_productgrid_presence_trend_chart_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/KeywordsWithProductGridPresenceInputModel'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/PresenceTrendChartResult'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
/5.0/productgrid/grid_types/trend_chart:
post:
tags:
- product_grid
summary: Get grid types breakdown info
operationId: get_grid_types_trend_chart_5_0_productgrid_grid_types_trend_chart_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/KeywordsWithProductGridPresenceInputModel'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/GridTypesTrendChartResult'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
/5.0/productgrid/top_products/trend_chart:
post:
tags:
- product_grid
summary: Get keyword top products trend chart
description: Get top products trend chart data for a given account and time range.
operationId: get_top_products_trend_chart_5_0_productgrid_top_products_trend_chart_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TopProductsTrendChartInputModel'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/TopProductsTrendChartResult'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
/5.0/productgrid/keywords_with_product_grid_presence:
post:
tags:
- product_grid
summary: Get keywords with product grid presence info
operationId: get_keywords_with_product_grid_presence_5_0_productgrid_keywords_with_product_grid_presence_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/KeywordsWithProductGridPresenceInputModel'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/KeywordsWithProductGridPresenceResult'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
/5.0/productgrid/keywords/export:
post:
tags:
- product_grid
summary: Export keyword metrics data as CSV
description: Export keyword metrics data as CSV with specified columns.
operationId: export_keyword_metrics_csv_5_0_productgrid_keywords_export_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CSVKeywordMetricsExportRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
/5.0/productgrid/keyword_groups/export:
post:
tags:
- product_grid
summary: Export keyword group metrics data as CSV
description: Export keyword group metrics data as CSV with specified columns.
operationId: export_keyword_group_metrics_csv_5_0_productgrid_keyword_groups_export_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CSVKeywordGroupMetricsExportRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
/latest5/productgrid/info:
post:
tags:
- product_grid
summary: Test
operationId: info_latest5_productgrid_info_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AccountInputModel'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
/latest5/productgrid/keywords:
post:
tags:
- product_grid
summary: Get keyword metrics data
operationId: get_keyword_metrics_latest5_productgrid_keywords_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/KeywordsMetricsInputModel'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/KeywordMetricsResult'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
/latest5/productgrid/keyword_groups:
post:
tags:
- product_grid
summary: Get keyword group metrics data
operationId: get_keyword_group_metrics_latest5_productgrid_keyword_groups_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/KeywordGroupMetricsInputModel'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/KeywordGroupMetricsResult'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
/latest5/productgrid/top_sellers/trend_chart:
post:
tags:
- product_grid
summary: Get keyword top sellers trend chart
description: Get top sellers trend chart data for a given account and time range.
operationId: get_top_sellers_trend_chart_latest5_productgrid_top_sellers_trend_chart_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TopSellersTrendChartInputModel'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/TopSellersTrendChartResult'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
/latest5/productgrid/presence/trend_chart:
post:
tags:
- product_grid
summary: Get presence breakdown info
operationId: get_product_grid_presence_trend_chart_latest5_productgrid_presence_trend_chart_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/KeywordsWithProductGridPresenceInputModel'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/PresenceTrendChartResult'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
/latest5/productgrid/grid_types/trend_chart:
post:
tags:
- product_grid
summary: Get grid types breakdown info
operationId: get_grid_types_trend_chart_latest5_productgrid_grid_types_trend_chart_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/KeywordsWithProductGridPresenceInputModel'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/GridTypesTrendChartResult'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
/latest5/productgrid/top_products/trend_chart:
post:
tags:
- product_grid
summary: Get keyword top products trend chart
description: Get top products trend chart data for a given account and time range.
operationId: get_top_products_trend_chart_latest5_productgrid_top_products_trend_chart_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TopProductsTrendChartInputModel'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/TopProductsTrendChartResult'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
/latest5/productgrid/keywords_with_product_grid_presence:
post:
tags:
- product_grid
summary: Get keywords with product grid presence info
operationId: get_keywords_with_product_grid_presence_latest5_productgrid_keywords_with_product_grid_presence_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/KeywordsWithProductGridPresenceInputModel'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/KeywordsWithProductGridPresenceResult'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
/latest5/productgrid/keywords/export:
post:
tags:
- product_grid
summary: Export keyword metrics data as CSV
description: Export keyword metrics data as CSV with specified columns.
operationId: export_keyword_metrics_csv_latest5_productgrid_keywords_export_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CSVKeywordMetricsExportRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
/latest5/productgrid/keyword_groups/export:
post:
tags:
- product_grid
summary: Export keyword group metrics data as CSV
description: Export keyword group metrics data as CSV with specified columns.
operationId: export_keyword_group_metrics_csv_latest5_productgrid_keyword_groups_export_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CSVKeywordGroupMetricsExportRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
components:
schemas:
GridTypesTrendChartTypeItem:
properties:
group_title:
type: string
title: Group Title
results:
items:
$ref: '#/components/schemas/GridTypesTrendChartTimeItem'
type: array
title: Results
type: object
required:
- group_title
- results
title: GridTypesTrendChartTypeItem
description: Grid types trend chart type item model.
GridTypesTrendChartResult:
properties:
data:
items:
$ref: '#/components/schemas/GridTypesTrendChartTypeItem'
type: array
title: Data
total:
type: integer
title: Total
type: object
required:
- data
- total
title: GridTypesTrendChartResult
description: Grid types trend chart result model.
KeywordMetricsResult:
properties:
data:
items:
$ref: '#/components/schemas/KeywordMetricsItem'
type: array
title: Data
total:
type: integer
title: Total
branded_keywords:
type: integer
title: Branded Keywords
non_branded_keywords:
type: integer
title: Non Branded Keywords
type: object
required:
- data
- total
title: KeywordMetricsResult
PaginationInput:
properties:
limit:
type: integer
title: Limit
default: 30000
offset:
type: integer
title: Offset
default: 0
type: object
title: PaginationInput
description: Pagination input model.
TopSellersTrendChartResult:
properties:
data:
items:
type: object
type: array
title: Data
total:
type: integer
title: Total
type: object
required:
- data
- total
title: TopSellersTrendChartResult
KeywordGroupMetricsInputModel:
properties:
account_id:
type: integer
title: Account Id
domain_id:
type: integer
title: Domain Id
time_frequency:
type: string
title: Time Frequency
compare_time_range:
items:
type: integer
type: array
maxItems: 2
minItems: 2
title: Compare Time Range
search_engine:
items: {}
type: array
title: Search Engine
description: search engine
filters:
items:
items:
anyOf:
- type: string
- items:
type: integer
type: array
- items: {}
type: array
type: array
type: array
title: Filters
description: filters
pagination:
allOf:
- $ref: '#/components/schemas/PaginationInput'
title: Pagination
description: Pagination
sort_by:
type: string
title: Sort By
description: Sort by
order:
type: string
title: Order
description: Sort order
current_domain_filter:
type: boolean
title: Current Domain Filter
description: Current domain filter
is_branded:
type: boolean
title: Is Branded
description: If the query should filter by branded keywords.
keyword_groups:
items:
type: integer
type: array
title: Keyword Groups
description: Keyword group
presence_filter:
items:
type: integer
type: array
title: Presence Filter
description: Domain presence filter
domain_presence_filter:
items:
type: integer
type: array
title: Domain Presence Filter
description: Domain presence filter
product_grid_presence_filter:
type: integer
title: Product Grid Presence Filter
description: Product grid presence filter
time_value:
items:
type: integer
type: array
maxItems: 2
minItems: 2
title: Time Value
count:
type: boolean
title: Count
description: If the query should count the number of keyword_groups.
default: false
is_lr_enhancement_enabled:
type: boolean
title: Is Lr Enhancement Enabled
description: Enable LR enhancement features
default: false
page_num:
type: integer
title: Page Num
description: Page num 1 results
type: object
required:
- account_id
- time_frequency
- search_engine
title: KeywordGroupMetricsInputModel
description: Input model for keyword metrics.
KeywordsWithProductGridPresenceResult:
properties:
data:
items:
$ref: '#/components/schemas/KeywordsWithProductGridPresenceItem'
type: array
title: Data
type: object
required:
- data
title: KeywordsWithProductGridPresenceResult
description: Keywords with product grid presence item model.
ColumnConfig:
properties:
field:
type: string
title: Field
title:
type: string
title: Title
type:
type: string
title: Type
type: object
required:
- field
- title
- type
title: ColumnConfig
TopSellersTrendChartInputModel:
properties:
account_id:
type: integer
title: Account Id
domain_id:
type: integer
title: Domain Id
time_frequency:
type: string
title: Time Frequency
compare_time_range:
items:
type: integer
type: array
title: Compare Time Range
search_engine:
items: {}
type: array
title: Search Engine
description: search engine
filters:
items:
items:
anyOf:
- type: string
- items:
type: integer
type: array
- items: {}
type: array
type: array
type: array
title: Filters
description: filters
pagination:
allOf:
- $ref: '#/components/schemas/PaginationInput'
title: Pagination
description: Pagination
sort_by:
type: string
title: Sort By
description: Sort by
order:
type: string
title: Order
description: Sort order
current_domain_filter:
type: boolean
title: Current Domain Filter
description: Current domain filter
is_branded:
type: boolean
title: Is Branded
description: If the query should filter by branded keywords.
keyword_groups:
items:
type: integer
type: array
title: Keyword Groups
description: Keyword group
presence_filter:
items:
type: integer
type: array
title: Presence Filter
description: Domain presence filter
domain_presence_filter:
items:
type: integer
type: array
title: Domain Presence Filter
description: Domain presence filter
product_grid_presence_filter:
type: integer
title: Product Grid Presence Filter
description: Product grid presence filter
time_value:
items:
type: integer
type: array
maxItems: 2
minItems: 2
title: Time Value
is_lr_enhancement_enabled:
type: boolean
title: Is Lr Enhancement Enabled
description: Enable LR enhancement features
default: false
page_num:
type: integer
title: Page Num
description: Page num 1 results
type: object
required:
- account_id
- time_frequency
- search_engine
title: TopSellersTrendChartInputModel
description: Input model for top sellers trend chart.
KeywordsMetricsInputModel:
properties:
account_id:
type: integer
title: Account Id
domain_id:
type: integer
title: Domain Id
time_frequency:
type: string
title: Time Frequency
compare_time_range:
items:
type: integer
type: array
maxItems: 2
minItems: 2
title: Compare Time Range
search_engine:
items: {}
type: array
title: Search Engine
description: search engine
filters:
items:
items:
anyOf:
- type: string
- items:
type: integer
type: array
- items: {}
type: array
type: array
type: array
title: Filters
description: filters
pagination:
allOf:
- $ref: '#/components/schemas/PaginationInput'
title: Pagination
description: Pagination
sort_by:
type: string
title: Sort By
description: Sort by
order:
type: string
title: Order
description: Sort order
current_domain_filter:
type: boolean
title: Current Domain Filter
description: Current domain filter
is_branded:
type: boolean
title: Is Branded
description: If the query should filter by branded keywords.
keyword_groups:
items:
type: integer
type: array
title: Keyword Groups
description: Keyword group
presence_filter:
items:
type: integer
type: array
title: Presence Filter
description: Domain presence filter
domain_presence_filter:
items:
type: integer
type: array
title: Domain Presence Filter
description: Domain presence filter
product_grid_presence_filter:
type: integer
title: Product Grid Presence Filter
description: Product grid presence filter
time_value:
items:
type: integer
type: array
maxItems: 2
minItems: 2
title: Time Value
count:
type: boolean
title: Count
description: If the query should count the number of keywords.
default: false
is_lr_enhancement_enabled:
type: boolean
title: Is Lr Enhancement Enabled
description: Enable LR enhancement features
default: false
page_num:
type: integer
title: Page Num
description: Page num 1 results
type: object
required:
- account_id
- time_frequency
- search_engine
title: KeywordsMetricsInputModel
description: Input model for keyword metrics.
KeywordMetricsItem:
properties:
id:
type: integer
title: Id
keyword:
type: string
title: Keyword
group_titles:
items:
type: string
type: array
title: Group Titles
stores:
items:
type: string
type: array
title: Stores
search_volume:
type: integer
title: Search Volume
search_volume_diff:
type: integer
title: Search Volume Diff
search_volume_diffpercent:
type: number
title: Search Volume Diffpercent
clicks:
type: integer
title: Clicks
clicks_diff:
type: integer
title: Clicks Diff
clicks_diffpercent:
type: number
title: Clicks Diffpercent
blended_rank:
type: number
title: Blended Rank
blended_rank_diff:
type: number
title: Blended Rank Diff
blended_rank_diffpercent:
type: number
title: Blended Rank Diffpercent
tile_rank:
type: number
title: Tile Rank
tile_rank_diff:
type: number
title: Tile Rank Diff
tile_rank_diffpercent:
type: number
title: Tile Rank Diffpercent
domain_presence_product_grids_count:
type: integer
title: Domain Presence Product Grids Count
total_product_grid_presence_count:
type: integer
title: Total Product Grid Presence Count
domain_presence_top_grid_rank:
type: integer
title: Domain Presence Top Grid Rank
domain_presence_top_grid_rank_diff:
type: integer
title: Domain Presence Top Grid Rank Diff
domain_presence_top_grid_rank_prev:
type: integer
# --- truncated at 32 KB (50 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/brightedge-technologies/refs/heads/main/openapi/brightedge-technologies-product-grid-api-openapi.yml