BrightEdge Technologies legacy API
Operation ported over from legacy API
Operation ported over from legacy API
openapi: 3.1.0
info:
title: BrightEdge Platform accounts legacy API
description: This API provides the ability to integrate with BrightEdge Platform
version: 5.0.0
tags:
- name: legacy
description: Operation ported over from legacy API
paths:
/3.0/objects/accounts:
get:
tags:
- legacy
summary: This call returns the list of accounts this user can access
operationId: get_all_accounts_3_0_objects_accounts_get
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/LegacyAccountsListOut'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
- api_token_header: []
- bearer_token: []
/3.0/objects/accounts/{account_id}:
post:
tags:
- legacy
summary: This call returns the details of an individual account
operationId: get_account_3_0_objects_accounts__account_id__post
parameters:
- required: true
schema:
type: integer
title: Account Id
name: account_id
in: path
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LegacyAccountIn'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/LegacyAccountOut'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
- api_token_header: []
- bearer_token: []
/latest3/objects/accounts:
get:
tags:
- legacy
summary: This call returns the list of accounts this user can access
operationId: get_all_accounts_latest3_objects_accounts_get
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/LegacyAccountsListOut'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
- api_token_header: []
- bearer_token: []
/latest3/objects/accounts/{account_id}:
post:
tags:
- legacy
summary: This call returns the details of an individual account
operationId: get_account_latest3_objects_accounts__account_id__post
parameters:
- required: true
schema:
type: integer
title: Account Id
name: account_id
in: path
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/LegacyAccountIn'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/LegacyAccountOut'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
- api_token_header: []
- bearer_token: []
/3.0/objects/keywordgroups/{account_id}:
get:
tags:
- legacy
summary: This call returns the list of keywordgroups an account can access
operationId: get_account_keywordgroups_3_0_objects_keywordgroups__account_id__get
parameters:
- required: true
schema:
type: integer
title: Account Id
name: account_id
in: path
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/LegacyKeywordGroupOut'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
- api_token_header: []
- bearer_token: []
/3.0/objects/keywordgroups/{account_id}/{keyword_group_id}:
get:
tags:
- legacy
summary: This call returns a list of keywords within the give keyword group
operationId: get_account_keywordgroup_detail_3_0_objects_keywordgroups__account_id___keyword_group_id__get
parameters:
- required: true
schema:
type: integer
title: Account Id
name: account_id
in: path
- required: true
schema:
type: integer
title: Keyword Group Id
name: keyword_group_id
in: path
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/LegacyKeywordGroupDetailOut'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
- api_token_header: []
- bearer_token: []
/latest3/objects/keywordgroups/{account_id}:
get:
tags:
- legacy
summary: This call returns the list of keywordgroups an account can access
operationId: get_account_keywordgroups_latest3_objects_keywordgroups__account_id__get
parameters:
- required: true
schema:
type: integer
title: Account Id
name: account_id
in: path
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/LegacyKeywordGroupOut'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
- api_token_header: []
- bearer_token: []
/latest3/objects/keywordgroups/{account_id}/{keyword_group_id}:
get:
tags:
- legacy
summary: This call returns a list of keywords within the give keyword group
operationId: get_account_keywordgroup_detail_latest3_objects_keywordgroups__account_id___keyword_group_id__get
parameters:
- required: true
schema:
type: integer
title: Account Id
name: account_id
in: path
- required: true
schema:
type: integer
title: Keyword Group Id
name: keyword_group_id
in: path
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/LegacyKeywordGroupDetailOut'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
- api_token_header: []
- bearer_token: []
/3.0/objects/domains:
get:
tags:
- legacy
summary: This call returns a list of primary domains for accounts that the user has access to.
operationId: get_user_domains_3_0_objects_domains_get
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/LegacyCompetitorDomainOut'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
- api_token_header: []
- bearer_token: []
/3.0/objects/domains/{account_id}:
get:
tags:
- legacy
summary: This call returns a primary domain for given account id
operationId: get_account_domain_3_0_objects_domains__account_id__get
parameters:
- required: true
schema:
type: integer
title: Account Id
name: account_id
in: path
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/LegacyCompetitorDomainOut'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
- api_token_header: []
- bearer_token: []
/latest3/objects/domains:
get:
tags:
- legacy
summary: This call returns a list of primary domains for accounts that the user has access to.
operationId: get_user_domains_latest3_objects_domains_get
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/LegacyCompetitorDomainOut'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
- api_token_header: []
- bearer_token: []
/latest3/objects/domains/{account_id}:
get:
tags:
- legacy
summary: This call returns a primary domain for given account id
operationId: get_account_domain_latest3_objects_domains__account_id__get
parameters:
- required: true
schema:
type: integer
title: Account Id
name: account_id
in: path
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/LegacyCompetitorDomainOut'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
- api_token_header: []
- bearer_token: []
/3.0/objects/competitors/{account_id}:
get:
tags:
- legacy
summary: This call returns a competitors for given account id
operationId: get_account_competitors_3_0_objects_competitors__account_id__get
parameters:
- required: true
schema:
type: integer
title: Account Id
name: account_id
in: path
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/LegacyCompetitorDomainOut'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
- api_token_header: []
- bearer_token: []
/latest3/objects/competitors/{account_id}:
get:
tags:
- legacy
summary: This call returns a competitors for given account id
operationId: get_account_competitors_latest3_objects_competitors__account_id__get
parameters:
- required: true
schema:
type: integer
title: Account Id
name: account_id
in: path
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/LegacyCompetitorDomainOut'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
- api_token_header: []
- bearer_token: []
/3.0/objects/keywords/{account_id}:
get:
tags:
- legacy
summary: This call returns a list of keywords of the given account
operationId: get_account_keywords_3_0_objects_keywords__account_id__get
parameters:
- required: true
schema:
type: integer
title: Account Id
name: account_id
in: path
- required: false
schema:
type: integer
title: Offset
default: 0
name: offset
in: query
- required: false
schema:
type: integer
title: Count
default: 5000
name: count
in: query
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/LegacyKeywordOut'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
- api_token_header: []
- bearer_token: []
/latest3/objects/keywords/{account_id}:
get:
tags:
- legacy
summary: This call returns a list of keywords of the given account
operationId: get_account_keywords_latest3_objects_keywords__account_id__get
parameters:
- required: true
schema:
type: integer
title: Account Id
name: account_id
in: path
- required: false
schema:
type: integer
title: Offset
default: 0
name: offset
in: query
- required: false
schema:
type: integer
title: Count
default: 5000
name: count
in: query
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/LegacyKeywordOut'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
- api_token_header: []
- bearer_token: []
/3.0/objects/time/{account_id}/{time_frequency}/{day}:
get:
tags:
- legacy
summary: This call returns the time value for a given time frequency and day
operationId: get_time_value_3_0_objects_time__account_id___time_frequency___day__get
parameters:
- required: true
schema:
type: integer
title: Account Id
name: account_id
in: path
- required: true
schema:
$ref: '#/components/schemas/TimeTimeStringType'
name: time_frequency
in: path
- required: true
schema:
type: integer
maximum: 99991231.0
minimum: 19600101.0
title: The day number in YYYYMMDD format
name: day
in: path
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/LegacyTimeFrequencyOut'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
- api_token_header: []
- bearer_token: []
/latest3/objects/time/{account_id}/{time_frequency}/{day}:
get:
tags:
- legacy
summary: This call returns the time value for a given time frequency and day
operationId: get_time_value_latest3_objects_time__account_id___time_frequency___day__get
parameters:
- required: true
schema:
type: integer
title: Account Id
name: account_id
in: path
- required: true
schema:
$ref: '#/components/schemas/TimeTimeStringType'
name: time_frequency
in: path
- required: true
schema:
type: integer
maximum: 99991231.0
minimum: 19600101.0
title: The day number in YYYYMMDD format
name: day
in: path
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/LegacyTimeFrequencyOut'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
- api_token_header: []
- bearer_token: []
/3.0/objects/datacube_searchengines/{account_id}:
get:
tags:
- legacy
summary: This call returns the list of all the datacube search engines for given account_id
operationId: get_account_datacube_searchengines_3_0_objects_datacube_searchengines__account_id__get
parameters:
- required: true
schema:
type: integer
title: Account Id
name: account_id
in: path
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/LegacyDatacubeSearchenginesOut'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
- api_token_header: []
- bearer_token: []
/latest3/objects/datacube_searchengines/{account_id}:
get:
tags:
- legacy
summary: This call returns the list of all the datacube search engines for given account_id
operationId: get_account_datacube_searchengines_latest3_objects_datacube_searchengines__account_id__get
parameters:
- required: true
schema:
type: integer
title: Account Id
name: account_id
in: path
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/LegacyDatacubeSearchenginesOut'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
- api_token_header: []
- bearer_token: []
/3.0/objects/searchengines/{account_id}:
get:
tags:
- legacy
summary: This call returns the list of all the search engines for given account_id
operationId: get_account_searchengines_3_0_objects_searchengines__account_id__get
parameters:
- required: true
schema:
type: integer
title: Account Id
name: account_id
in: path
- required: false
schema:
type: integer
title: Active
default: 0
name: active
in: query
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/LegacySearchenginesOut'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
- api_token_header: []
- bearer_token: []
/latest3/objects/searchengines/{account_id}:
get:
tags:
- legacy
summary: This call returns the list of all the search engines for given account_id
operationId: get_account_searchengines_latest3_objects_searchengines__account_id__get
parameters:
- required: true
schema:
type: integer
title: Account Id
name: account_id
in: path
- required: false
schema:
type: integer
title: Active
default: 0
name: active
in: query
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/LegacySearchenginesOut'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
- api_token_header: []
- bearer_token: []
/3.0/objects/query/{account_id}:
post:
tags:
- legacy
summary: This call returns the BUDD BQL query results (for internal use only)
operationId: budd_bql_query_3_0_objects_query__account_id__post
parameters:
- required: true
schema:
type: integer
title: Account Id
name: account_id
in: path
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: []
- api_token_header: []
- bearer_token: []
/latest3/objects/query/{account_id}:
post:
tags:
- legacy
summary: This call returns the BUDD BQL query results (for internal use only)
operationId: budd_bql_query_latest3_objects_query__account_id__post
parameters:
- required: true
schema:
type: integer
title: Account Id
name: account_id
in: path
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: []
- api_token_header: []
- bearer_token: []
/3.0/query/{account_id}:
post:
tags:
- legacy
summary: This call returns the BUDD BQL query results (for customers)
operationId: budd_bql_query_3_0_query__account_id__post
parameters:
- required: true
schema:
type: integer
title: Account Id
name: account_id
in: path
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: []
- api_token_header: []
- bearer_token: []
/latest3/query/{account_id}:
post:
tags:
- legacy
summary: This call returns the BUDD BQL query results (for customers)
operationId: budd_bql_query_latest3_query__account_id__post
parameters:
- required: true
schema:
type: integer
title: Account Id
name: account_id
in: path
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: []
- api_token_header: []
- bearer_token: []
/3.0/objects/qa_query/{account_id}:
post:
tags:
- legacy
summary: This call returns the BUDD BQL query results only for QA
operationId: budd_bql_query_qa_3_0_objects_qa_query__account_id__post
parameters:
- required: true
schema:
type: integer
title: Account Id
name: account_id
in: path
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: []
- api_token_header: []
- bearer_token: []
/latest3/objects/qa_query/{account_id}:
post:
tags:
- legacy
summary: This call returns the BUDD BQL query results only for QA
operationId: budd_bql_query_qa_latest3_objects_qa_query__account_id__post
parameters:
- required: true
schema:
type: integer
title: Account Id
name: account_id
in: path
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: []
- api_token_header: []
- bearer_token: []
components:
schemas:
LegacyKeywordGroupDetailOut:
properties:
keywordgroups:
items:
$ref: '#/components/schemas/LegacyKeywordGroupDetailShortOut'
type: array
title: Keywordgroups
type: object
required:
- keywordgroups
title: LegacyKeywordGroupDetailOut
LegacyAccountShortOut:
properties:
id:
type: string
title: Id
account:
type: string
title: Account
type: object
required:
- id
- account
title: LegacyAccountShortOut
TimeTimeStringType:
type: string
enum:
- daily
- weekly
- monthly
- quarterly
- yearly
- fiscal_weekly
- fiscal_monthly
- fiscal_quarterly
- fiscal_yearly
title: TimeTimeStringType
description: An enumeration.
LegacyAccountOut:
properties:
account_name:
type: string
title: Account Name
account_id:
type: integer
title: Account Id
created_on_date:
type: string
format: date-time
title: Created On Date
account_primary_domain_tracked:
type: string
title: Account Primary Domain Tracked
GA_integration_setup:
type: string
title: Ga Integration Setup
GSC_integration_setup:
type: string
title: Gsc Integration Setup
GA_integrated_profile_id:
type: string
title: Ga Integrated Profile Id
GSC_integrated_sites:
items:
type: string
type: array
title: Gsc Integrated Sites
facebook_integration_setup:
type: string
title: Facebook Integration Setup
facebook_fan_page_integrated:
type: string
title: Facebook Fan Page Integrated
number_of_keywords_allocated:
type: integer
title: Number Of Keywords Allocated
number_of_keywords_used:
type: integer
title: Number Of Keywords Used
number_of_unused_keywords:
type: integer
title: Number Of Unused Keywords
number_of_allocated_competitors:
type: integer
title: Number Of Allocated Competitors
number_of_tracked_competitors:
type: integer
title: Number Of Tracked Competitors
number_of_unused_competitors:
type: integer
title: Number Of Unused Competitors
number_of_keywords_with_PLPs_default_SE:
type: integer
title: Number Of Keywords With Plps Default Se
number_of_keywords_with_PLPs_all_tracked_SE:
type: integer
title: Number Of Keywords With Plps All Tracked Se
number_of_page_groups:
type: integer
title: Number Of Page Groups
page_group_names:
items:
type: string
type: array
title: Page Group Names
last_logged_into_date_for_the_account:
type: string
format: date-time
title: Last Logged Into Date For The Account
type: object
required:
- account_name
- account_id
- created_on_date
- account_primary_domain_tracked
- GA_integration_setup
- GSC_integration_setup
- GA_integrated_profile_id
- GSC_integrated_sites
- facebook_integration_setup
- facebook_fan_page_integrated
- number_of_keywords_allocated
- number_of_keywords_used
- number_of_unused_keywords
- number_of_allocated_competitors
- number_of_tracked_competitors
- number_of_unused_competitors
- number_of_keywords_with_PLPs_default_SE
- number_of_keywords_with_PLPs_all_tracked_SE
- number_of_page_groups
- page_group_names
title: LegacyAccountOut
LegacyKeywordGroupDetailKeywordShortOut:
properties:
id:
type: string
title: Id
name:
type: string
title: Name
type: object
required:
- id
- name
title: LegacyKeywordGroupDetailKeywordShortOut
LegacyAccountIn:
properties:
excluded_keyword_group_filter:
items:
type: string
type: array
title: Excluded Keyword Group Filter
type: object
title: LegacyAccountIn
LegacyKeywordOut:
properties:
count:
type: string
title: Count
total:
type: string
title: Total
offset:
type: string
title: Offset
keywords:
items:
$ref: '
# --- truncated at 32 KB (38 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/brightedge-technologies/refs/heads/main/openapi/brightedge-technologies-legacy-api-openapi.yml