BrightEdge Technologies accounts API
Operation related to accounts
Operation related to accounts
openapi: 3.1.0
info:
title: BrightEdge Platform accounts API
description: This API provides the ability to integrate with BrightEdge Platform
version: 5.0.0
tags:
- name: accounts
description: Operation related to accounts
paths:
/5.0/objects/accounts:
get:
tags:
- accounts
summary: This call returns the list of accounts this user can access
operationId: get_all_accounts_5_0_objects_accounts_get
responses:
'200':
description: Successful Response
content:
application/json:
schema:
items:
$ref: '#/components/schemas/AccountOut'
type: array
title: Response Get All Accounts 5 0 Objects Accounts Get
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
- api_token_header: []
- bearer_token: []
/5.0/objects/accounts/{account_id}:
post:
tags:
- accounts
summary: This call returns the details of an individual account
operationId: get_account_5_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/AccountIdIn'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AccountIdOut'
'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: []
/latest5/objects/accounts:
get:
tags:
- accounts
summary: This call returns the list of accounts this user can access
operationId: get_all_accounts_latest5_objects_accounts_get
responses:
'200':
description: Successful Response
content:
application/json:
schema:
items:
$ref: '#/components/schemas/AccountOut'
type: array
title: Response Get All Accounts Latest5 Objects Accounts Get
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
- api_token_header: []
- bearer_token: []
/latest5/objects/accounts/{account_id}:
post:
tags:
- accounts
summary: This call returns the details of an individual account
operationId: get_account_latest5_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/AccountIdIn'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AccountIdOut'
'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: []
/5.0/objects/competitors/{account_id}:
get:
tags:
- accounts
summary: This call returns a competitors for given account id
operationId: get_account_competitors_5_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:
items:
$ref: '#/components/schemas/CompetitorOut'
type: array
title: Response Get Account Competitors 5 0 Objects Competitors Account Id Get
'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: []
/latest5/objects/competitors/{account_id}:
get:
tags:
- accounts
summary: This call returns a competitors for given account id
operationId: get_account_competitors_latest5_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:
items:
$ref: '#/components/schemas/CompetitorOut'
type: array
title: Response Get Account Competitors Latest5 Objects Competitors Account Id Get
'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: []
/5.0/objects/brandfilters/{account_id}:
get:
tags:
- accounts
summary: This call returns a string of bql filters for branded keywords.
operationId: get_brand_filters_keywords_for_account_5_0_objects_brandfilters__account_id__get
parameters:
- required: true
schema:
type: integer
title: Account Id
name: account_id
in: path
- required: false
schema:
type: boolean
title: Branded
default: true
name: branded
in: query
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/BrandFiltersOut'
'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: []
/latest5/objects/brandfilters/{account_id}:
get:
tags:
- accounts
summary: This call returns a string of bql filters for branded keywords.
operationId: get_brand_filters_keywords_for_account_latest5_objects_brandfilters__account_id__get
parameters:
- required: true
schema:
type: integer
title: Account Id
name: account_id
in: path
- required: false
schema:
type: boolean
title: Branded
default: true
name: branded
in: query
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/BrandFiltersOut'
'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: []
/5.0/objects/time/{account_id}/{time_frequency}/{day}:
get:
tags:
- accounts
summary: This call returns the time value for a given time frequency and day
operationId: get_time_value_5_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/TimeFrequencyOut'
'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: []
/latest5/objects/time/{account_id}/{time_frequency}/{day}:
get:
tags:
- accounts
summary: This call returns the time value for a given time frequency and day
operationId: get_time_value_latest5_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/TimeFrequencyOut'
'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: []
/5.0/objects/domains:
get:
tags:
- accounts
summary: This call returns a list of primary domains for accounts that the user has access to.
operationId: get_user_domains_5_0_objects_domains_get
responses:
'200':
description: Successful Response
content:
application/json:
schema:
items:
$ref: '#/components/schemas/DomainOut'
type: array
title: Response Get User Domains 5 0 Objects Domains Get
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
- api_token_header: []
- bearer_token: []
/5.0/objects/domains/{account_id}:
get:
tags:
- accounts
summary: This call returns a primary domain for given account id
operationId: get_account_domain_5_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/DomainOut'
'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: []
/latest5/objects/domains:
get:
tags:
- accounts
summary: This call returns a list of primary domains for accounts that the user has access to.
operationId: get_user_domains_latest5_objects_domains_get
responses:
'200':
description: Successful Response
content:
application/json:
schema:
items:
$ref: '#/components/schemas/DomainOut'
type: array
title: Response Get User Domains Latest5 Objects Domains Get
security:
- http_basic: []
- forwarded_http_basic: []
- session_cookie: []
- session_header: []
- api_token_header: []
- bearer_token: []
/latest5/objects/domains/{account_id}:
get:
tags:
- accounts
summary: This call returns a primary domain for given account id
operationId: get_account_domain_latest5_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/DomainOut'
'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: []
/5.0/objects/keywords/{account_id}:
get:
tags:
- accounts
summary: This call returns a list of keywords of the given account
operationId: get_account_keywords_5_0_objects_keywords__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:
items:
$ref: '#/components/schemas/KeywordOut'
type: array
title: Response Get Account Keywords 5 0 Objects Keywords Account Id Get
'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: []
/latest5/objects/keywords/{account_id}:
get:
tags:
- accounts
summary: This call returns a list of keywords of the given account
operationId: get_account_keywords_latest5_objects_keywords__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:
items:
$ref: '#/components/schemas/KeywordOut'
type: array
title: Response Get Account Keywords Latest5 Objects Keywords Account Id Get
'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: []
/5.0/objects/keywordgroups/{account_id}:
get:
tags:
- accounts
summary: This call returns a list of keyword groups of the given account
operationId: get_account_keywordgroups_5_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:
items:
$ref: '#/components/schemas/KeywordGroupOut'
type: array
title: Response Get Account Keywordgroups 5 0 Objects Keywordgroups Account Id Get
'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: []
/5.0/objects/keywordgroups/{account_id}/{keyword_group_id}:
get:
tags:
- accounts
summary: This call returns a list of keywords within the give keyword group
operationId: get_account_keywordgroup_detail_5_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/KeywordGroupDetailOut'
'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: []
post:
tags:
- accounts
summary: '[WIP] This call adds a list of keywords to the give keyword group'
operationId: add_kw_to_kwg_in_account_5_0_objects_keywordgroups__account_id___keyword_group_id__post
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
requestBody:
content:
application/json:
schema:
items:
additionalProperties:
type: string
type: object
type: array
title: Kw List
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: []
- api_token_header: []
- bearer_token: []
/latest5/objects/keywordgroups/{account_id}:
get:
tags:
- accounts
summary: This call returns a list of keyword groups of the given account
operationId: get_account_keywordgroups_latest5_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:
items:
$ref: '#/components/schemas/KeywordGroupOut'
type: array
title: Response Get Account Keywordgroups Latest5 Objects Keywordgroups Account Id Get
'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: []
/latest5/objects/keywordgroups/{account_id}/{keyword_group_id}:
get:
tags:
- accounts
summary: This call returns a list of keywords within the give keyword group
operationId: get_account_keywordgroup_detail_latest5_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/KeywordGroupDetailOut'
'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: []
post:
tags:
- accounts
summary: '[WIP] This call adds a list of keywords to the give keyword group'
operationId: add_kw_to_kwg_in_account_latest5_objects_keywordgroups__account_id___keyword_group_id__post
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
requestBody:
content:
application/json:
schema:
items:
additionalProperties:
type: string
type: object
type: array
title: Kw List
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: []
- api_token_header: []
- bearer_token: []
/5.0/objects/query/{account_id}:
post:
tags:
- accounts
summary: '[Work in Progrees]: This call returns data based on submitted BQL (BrightEdge Query Language) request'
operationId: get_query_results_5_0_objects_query__account_id__post
parameters:
- required: true
schema:
type: integer
title: Account Id
name: account_id
in: path
- required: false
schema:
allOf:
- $ref: '#/components/schemas/FeatureName'
default: platformapi
name: feature_name
in: query
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/BQLQueryOut'
'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: []
/latest5/objects/query/{account_id}:
post:
tags:
- accounts
summary: '[Work in Progrees]: This call returns data based on submitted BQL (BrightEdge Query Language) request'
operationId: get_query_results_latest5_objects_query__account_id__post
parameters:
- required: true
schema:
type: integer
title: Account Id
name: account_id
in: path
- required: false
schema:
allOf:
- $ref: '#/components/schemas/FeatureName'
default: platformapi
name: feature_name
in: query
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/BQLQueryOut'
'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: []
/5.0/objects/searchengines/{account_id}:
get:
tags:
- accounts
summary: This call returns a list of search engines for given account id
operationId: get_account_searchengines_5_0_objects_searchengines__account_id__get
parameters:
- required: true
schema:
type: integer
title: Account Id
name: account_id
in: path
- required: false
schema:
type: boolean
title: Active
default: true
name: active
in: query
responses:
'200':
description: Successful Response
content:
application/json:
schema:
items:
$ref: '#/components/schemas/SearchEngineOut'
type: array
title: Response Get Account Searchengines 5 0 Objects Searchengines Account Id Get
'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: []
/latest5/objects/searchengines/{account_id}:
get:
tags:
- accounts
summary: This call returns a list of search engines for given account id
operationId: get_account_searchengines_latest5_objects_searchengines__account_id__get
parameters:
- required: true
schema:
type: integer
title: Account Id
name: account_id
in: path
- required: false
schema:
type: boolean
title: Active
default: true
name: active
in: query
responses:
'200':
description: Successful Response
content:
application/json:
schema:
items:
$ref: '#/components/schemas/SearchEngineOut'
type: array
title: Response Get Account Searchengines Latest5 Objects Searchengines Account Id Get
'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/accounts:
get:
tags:
- accounts
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:
- accounts
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:
- accounts
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:
- accounts
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:
- accounts
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:
# --- truncated at 32 KB (71 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/brightedge-technologies/refs/heads/main/openapi/brightedge-technologies-accounts-api-openapi.yml