{ "opencollection": "1.0.0", "info": { "name": "BrightEdge Platform accounts API", "version": "5.0.0" }, "items": [ { "info": { "name": "accounts", "type": "folder" }, "items": [ { "info": { "name": "This call returns the list of accounts this user can access", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/5.0/objects/accounts", "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "This call returns the list of accounts this user can access" }, { "info": { "name": "This call returns the details of an individual account", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/5.0/objects/accounts/:account_id", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "This call returns the details of an individual account" }, { "info": { "name": "This call returns the list of accounts this user can access", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/latest5/objects/accounts", "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "This call returns the list of accounts this user can access" }, { "info": { "name": "This call returns the details of an individual account", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/latest5/objects/accounts/:account_id", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "This call returns the details of an individual account" }, { "info": { "name": "This call returns a competitors for given account id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/5.0/objects/competitors/:account_id", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "This call returns a competitors for given account id" }, { "info": { "name": "This call returns a competitors for given account id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/latest5/objects/competitors/:account_id", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "This call returns a competitors for given account id" }, { "info": { "name": "This call returns a string of bql filters for branded keywords.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/5.0/objects/brandfilters/:account_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "branded", "value": "", "type": "query" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "This call returns a string of bql filters for branded keywords." }, { "info": { "name": "This call returns a string of bql filters for branded keywords.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/latest5/objects/brandfilters/:account_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "branded", "value": "", "type": "query" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "This call returns a string of bql filters for branded keywords." }, { "info": { "name": "This call returns the time value for a given time frequency and day", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/5.0/objects/time/:account_id/:time_frequency/:day", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "time_frequency", "value": "", "type": "path" }, { "name": "day", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "This call returns the time value for a given time frequency and day" }, { "info": { "name": "This call returns the time value for a given time frequency and day", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/latest5/objects/time/:account_id/:time_frequency/:day", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "time_frequency", "value": "", "type": "path" }, { "name": "day", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "This call returns the time value for a given time frequency and day" }, { "info": { "name": "This call returns a list of primary domains for accounts that the user has access to.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/5.0/objects/domains", "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "This call returns a list of primary domains for accounts that the user has access to." }, { "info": { "name": "This call returns a primary domain for given account id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/5.0/objects/domains/:account_id", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "This call returns a primary domain for given account id" }, { "info": { "name": "This call returns a list of primary domains for accounts that the user has access to.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/latest5/objects/domains", "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "This call returns a list of primary domains for accounts that the user has access to." }, { "info": { "name": "This call returns a primary domain for given account id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/latest5/objects/domains/:account_id", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "This call returns a primary domain for given account id" }, { "info": { "name": "This call returns a list of keywords of the given account", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/5.0/objects/keywords/:account_id", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "This call returns a list of keywords of the given account" }, { "info": { "name": "This call returns a list of keywords of the given account", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/latest5/objects/keywords/:account_id", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "This call returns a list of keywords of the given account" }, { "info": { "name": "This call returns a list of keyword groups of the given account", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/5.0/objects/keywordgroups/:account_id", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "This call returns a list of keyword groups of the given account" }, { "info": { "name": "This call returns a list of keywords within the give keyword group", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/5.0/objects/keywordgroups/:account_id/:keyword_group_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "keyword_group_id", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "This call returns a list of keywords within the give keyword group" }, { "info": { "name": "[WIP] This call adds a list of keywords to the give keyword group", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/5.0/objects/keywordgroups/:account_id/:keyword_group_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "keyword_group_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "[WIP] This call adds a list of keywords to the give keyword group" }, { "info": { "name": "This call returns a list of keyword groups of the given account", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/latest5/objects/keywordgroups/:account_id", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "This call returns a list of keyword groups of the given account" }, { "info": { "name": "This call returns a list of keywords within the give keyword group", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/latest5/objects/keywordgroups/:account_id/:keyword_group_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "keyword_group_id", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "This call returns a list of keywords within the give keyword group" }, { "info": { "name": "[WIP] This call adds a list of keywords to the give keyword group", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/latest5/objects/keywordgroups/:account_id/:keyword_group_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "keyword_group_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "[WIP] This call adds a list of keywords to the give keyword group" }, { "info": { "name": "[Work in Progrees]: This call returns data based on submitted BQL (BrightEdge Query Language) request", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/5.0/objects/query/:account_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "feature_name", "value": "", "type": "query" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "[Work in Progrees]: This call returns data based on submitted BQL (BrightEdge Query Language) request" }, { "info": { "name": "[Work in Progrees]: This call returns data based on submitted BQL (BrightEdge Query Language) request", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/latest5/objects/query/:account_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "feature_name", "value": "", "type": "query" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "[Work in Progrees]: This call returns data based on submitted BQL (BrightEdge Query Language) request" }, { "info": { "name": "This call returns a list of search engines for given account id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/5.0/objects/searchengines/:account_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "active", "value": "", "type": "query" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "This call returns a list of search engines for given account id" }, { "info": { "name": "This call returns a list of search engines for given account id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/latest5/objects/searchengines/:account_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "active", "value": "", "type": "query" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "This call returns a list of search engines for given account id" }, { "info": { "name": "This call returns the list of accounts this user can access", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/3.0/objects/accounts", "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "This call returns the list of accounts this user can access" }, { "info": { "name": "This call returns the details of an individual account", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/3.0/objects/accounts/:account_id", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "This call returns the details of an individual account" }, { "info": { "name": "This call returns the list of accounts this user can access", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/latest3/objects/accounts", "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "This call returns the list of accounts this user can access" }, { "info": { "name": "This call returns the details of an individual account", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/latest3/objects/accounts/:account_id", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "This call returns the details of an individual account" }, { "info": { "name": "This call returns the list of keywordgroups an account can access", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/3.0/objects/keywordgroups/:account_id", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "This call returns the list of keywordgroups an account can access" }, { "info": { "name": "This call returns a list of keywords within the give keyword group", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/3.0/objects/keywordgroups/:account_id/:keyword_group_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "keyword_group_id", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "This call returns a list of keywords within the give keyword group" }, { "info": { "name": "This call returns the list of keywordgroups an account can access", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/latest3/objects/keywordgroups/:account_id", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "This call returns the list of keywordgroups an account can access" }, { "info": { "name": "This call returns a list of keywords within the give keyword group", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/latest3/objects/keywordgroups/:account_id/:keyword_group_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "keyword_group_id", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "This call returns a list of keywords within the give keyword group" }, { "info": { "name": "This call returns a list of primary domains for accounts that the user has access to.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/3.0/objects/domains", "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "This call returns a list of primary domains for accounts that the user has access to." }, { "info": { "name": "This call returns a primary domain for given account id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/3.0/objects/domains/:account_id", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "This call returns a primary domain for given account id" }, { "info": { "name": "This call returns a list of primary domains for accounts that the user has access to.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/latest3/objects/domains", "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "This call returns a list of primary domains for accounts that the user has access to." }, { "info": { "name": "This call returns a primary domain for given account id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/latest3/objects/domains/:account_id", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "This call returns a primary domain for given account id" }, { "info": { "name": "This call returns a competitors for given account id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/3.0/objects/competitors/:account_id", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "This call returns a competitors for given account id" }, { "info": { "name": "This call returns a competitors for given account id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/latest3/objects/competitors/:account_id", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "This call returns a competitors for given account id" }, { "info": { "name": "This call returns a list of keywords of the given account", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/3.0/objects/keywords/:account_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "offset", "value": "", "type": "query" }, { "name": "count", "value": "", "type": "query" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "This call returns a list of keywords of the given account" }, { "info": { "name": "This call returns a list of keywords of the given account", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/latest3/objects/keywords/:account_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "offset", "value": "", "type": "query" }, { "name": "count", "value": "", "type": "query" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "This call returns a list of keywords of the given account" }, { "info": { "name": "This call returns the time value for a given time frequency and day", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/3.0/objects/time/:account_id/:time_frequency/:day", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "time_frequency", "value": "", "type": "path" }, { "name": "day", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "This call returns the time value for a given time frequency and day" }, { "info": { "name": "This call returns the time value for a given time frequency and day", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/latest3/objects/time/:account_id/:time_frequency/:day", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "time_frequency", "value": "", "type": "path" }, { "name": "day", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "This call returns the time value for a given time frequency and day" }, { "info": { "name": "This call returns the list of all the datacube search engines for given account_id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/3.0/objects/datacube_searchengines/:account_id", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "This call returns the list of all the datacube search engines for given account_id" }, { "info": { "name": "This call returns the list of all the datacube search engines for given account_id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/latest3/objects/datacube_searchengines/:account_id", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "This call returns the list of all the datacube search engines for given account_id" }, { "info": { "name": "This call returns the list of all the search engines for given account_id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/3.0/objects/searchengines/:account_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "active", "value": "", "type": "query" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "This call returns the list of all the search engines for given account_id" }, { "info": { "name": "This call returns the list of all the search engines for given account_id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/latest3/objects/searchengines/:account_id", "params": [ { "name": "account_id", "value": "", "type": "path" }, { "name": "active", "value": "", "type": "query" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "This call returns the list of all the search engines for given account_id" }, { "info": { "name": "This call returns the BUDD BQL query results (for internal use only)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/3.0/objects/query/:account_id", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "This call returns the BUDD BQL query results (for internal use only)" }, { "info": { "name": "This call returns the BUDD BQL query results (for internal use only)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/latest3/objects/query/:account_id", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "This call returns the BUDD BQL query results (for internal use only)" }, { "info": { "name": "This call returns the BUDD BQL query results (for customers)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/3.0/query/:account_id", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "This call returns the BUDD BQL query results (for customers)" }, { "info": { "name": "This call returns the BUDD BQL query results (for customers)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/latest3/query/:account_id", "params": [ { "name": "account_id", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "This call returns the BUDD BQL query results (for customers)" } ] } ], "bundled": true }