{"openapi":"3.1.0","info":{"title":"BrightEdge Platform API","description":"This API provides the ability to integrate with BrightEdge Platform","version":"5.0.0"},"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/be_local/save_multi_edit_changes":{"post":{"tags":["be_local","be_local"],"summary":"This call saves multi edit changes","description":"Changes of the format\n(location_name, field_name, attribute_name, before_value, after_value, task_id, extra_info_json)","operationId":"save_multi_edit_changes_5_0_objects_be_local_save_multi_edit_changes_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveGMBMultiEdit"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BELocalResponse"}}}},"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/be_local/update_fields":{"post":{"tags":["be_local","be_local"],"summary":"This call fetches all the quick wins tasks for a location","operationId":"update_fields_5_0_objects_be_local_update_fields_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFieldsGmbConfig"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BELocalResponse"}}}},"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/be_local/get_accounts_data":{"post":{"tags":["be_local","be_local"],"summary":"This call fetches all the entity data for all location of an account","operationId":"update_fields_5_0_objects_be_local_get_accounts_data_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAccountsData"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BELocalResponse"}}}},"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/be_local/get_location_details_v2":{"post":{"tags":["be_local"],"summary":"This call fetches all the locations linked to be_account","operationId":"get_location_details_v2_5_0_objects_be_local_get_location_details_v2_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationDetailConfigV2"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BELocalResponse"}}}},"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/be_local/get_all_gmb_attributes":{"post":{"tags":["be_local"],"summary":"This call fetches all the attributes","operationId":"get_all_gmb_attributes_5_0_objects_be_local_get_all_gmb_attributes_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAllAttributes"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BELocalResponse"}}}},"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/be_local/get_all_location_attributes":{"post":{"tags":["be_local"],"summary":"This call fetches all the location attributes","operationId":"get_all_location_attributes_5_0_objects_be_local_get_all_location_attributes_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetLocationAttributes"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BELocalResponse"}}}},"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/be_local/store_updates":{"post":{"tags":["be_local","be_local"],"summary":"Proxy store updates to prod platform-ui-api","operationId":"store_updates_5_0_objects_be_local_store_updates_post","requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/StoreUpdatesConfig"},"type":"array","title":"Reqbody"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BELocalResponse"}}}},"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/be_local/staging/store_updates":{"post":{"tags":["be_local","be_local"],"summary":"Proxy store updates to staging platform-ui-api","operationId":"store_updates_staging_5_0_objects_be_local_staging_store_updates_post","requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/StoreUpdatesConfig"},"type":"array","title":"Reqbody"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BELocalResponse"}}}},"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/be_local/save_multi_edit_changes":{"post":{"tags":["be_local","be_local"],"summary":"This call saves multi edit changes","description":"Changes of the format\n(location_name, field_name, attribute_name, before_value, after_value, task_id, extra_info_json)","operationId":"save_multi_edit_changes_latest5_objects_be_local_save_multi_edit_changes_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveGMBMultiEdit"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BELocalResponse"}}}},"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/be_local/update_fields":{"post":{"tags":["be_local","be_local"],"summary":"This call fetches all the quick wins tasks for a location","operationId":"update_fields_latest5_objects_be_local_update_fields_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFieldsGmbConfig"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BELocalResponse"}}}},"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/be_local/get_accounts_data":{"post":{"tags":["be_local","be_local"],"summary":"This call fetches all the entity data for all location of an account","operationId":"update_fields_latest5_objects_be_local_get_accounts_data_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAccountsData"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BELocalResponse"}}}},"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/be_local/get_location_details_v2":{"post":{"tags":["be_local"],"summary":"This call fetches all the locations linked to be_account","operationId":"get_location_details_v2_latest5_objects_be_local_get_location_details_v2_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationDetailConfigV2"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BELocalResponse"}}}},"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/be_local/get_all_gmb_attributes":{"post":{"tags":["be_local"],"summary":"This call fetches all the attributes","operationId":"get_all_gmb_attributes_latest5_objects_be_local_get_all_gmb_attributes_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAllAttributes"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BELocalResponse"}}}},"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/be_local/get_all_location_attributes":{"post":{"tags":["be_local"],"summary":"This call fetches all the location attributes","operationId":"get_all_location_attributes_latest5_objects_be_local_get_all_location_attributes_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetLocationAttributes"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BELocalResponse"}}}},"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/be_local/store_updates":{"post":{"tags":["be_local","be_local"],"summary":"Proxy store updates to prod platform-ui-api","operationId":"store_updates_latest5_objects_be_local_store_updates_post","requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/StoreUpdatesConfig"},"type":"array","title":"Reqbody"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BELocalResponse"}}}},"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/be_local/staging/store_updates":{"post":{"tags":["be_local","be_local"],"summary":"Proxy store updates to staging platform-ui-api","operationId":"store_updates_staging_latest5_objects_be_local_staging_store_updates_post","requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/StoreUpdatesConfig"},"type":"array","title":"Reqbody"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BELocalResponse"}}}},"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":["domains","competitors","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":["domains","competitors","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":["keywords","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":["keywords","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/info":{"get":{"tags":["core"],"summary":"Api Info","operationId":"api_info_5_0_info_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/5.0/high-latency-handle/{msec}":{"get":{"tags":["core"],"summary":"This call is used for concurrency load test","operationId":"high_latency_handle_5_0_high_latency_handle__msec__get","parameters":[{"required":true,"schema":{"type":"integer","title":"Msec"},"name":"msec","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/5.0/async-high-latency-handle/{msec}":{"get":{"tags":["core"],"summary":"This call is used for concurrency load test","operationId":"async_high_latency_handle_5_0_async_high_latency_handle__msec__get","parameters":[{"required":true,"schema":{"type":"integer","title":"Msec"},"name":"msec","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/5.0/objects/time/{account_id}/{time_frequency}/{day}":{"get":{"tags":["time","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/info":{"get":{"tags":["core"],"summary":"Api Info","operationId":"api_info_latest5_info_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/latest5/high-latency-handle/{msec}":{"get":{"tags":["core"],"summary":"This call is used for concurrency load test","operationId":"high_latency_handle_latest5_high_latency_handle__msec__get","parameters":[{"required":true,"schema":{"type":"integer","title":"Msec"},"name":"msec","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/latest5/async-high-latency-handle/{msec}":{"get":{"tags":["core"],"summary":"This call is used for concurrency load test","operationId":"async_high_latency_handle_latest5_async_high_latency_handle__msec__get","parameters":[{"required":true,"schema":{"type":"integer","title":"Msec"},"name":"msec","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/latest5/objects/time/{account_id}/{time_frequency}/{day}":{"get":{"tags":["time","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/chromeextension/keywordgroups/{account_id}":{"get":{"tags":["chromeextension","keywords"],"summary":"This call returns a list of keywordgroups for a given account","operationId":"get_kw_groups_5_0_chromeextension_keywordgroups__account_id__get","parameters":[{"required":true,"schema":{"type":"integer","title":"Account Id"},"name":"account_id","in":"path"},{"required":false,"schema":{"type":"integer","title":"Limit"},"name":"limit","in":"query"},{"required":false,"schema":{"type":"integer","title":"Offset"},"name":"offset","in":"query"},{"required":false,"schema":{"type":"boolean","title":"Only Total","default":false},"name":"only_total","in":"query"},{"required":false,"schema":{"type":"boolean","title":"Include Total","default":false},"name":"include_total","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeywordGroupOutResp"}}}},"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/chromeextension/keywords/{account_id}":{"get":{"tags":["chromeextension","keywords"],"summary":"This call returns a list of keywords with kwg_id for a given account","operationId":"get_account_kw_kwg_id_5_0_chromeextension_keywords__account_id__get","parameters":[{"required":true,"schema":{"type":"integer","title":"Account Id"},"name":"account_id","in":"path"},{"required":false,"schema":{"type":"integer","title":"Limit"},"name":"limit","in":"query"},{"required":false,"schema":{"type":"integer","title":"Offset"},"name":"offset","in":"query"},{"required":false,"schema":{"type":"boolean","title":"Only Total","default":false},"name":"only_total","in":"query"},{"required":false,"schema":{"type":"boolean","title":"Include Total","default":false},"name":"include_total","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeywordOutWithGroupResp"}}}},"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":["chromeextension","keywords"],"summary":"This call returns a list of keyword with kwg_id for a given account","operationId":"get_account_kw_kwg_id_5_0_chromeextension_keywords__account_id__post","parameters":[{"required":true,"schema":{"type":"integer","title":"Account Id"},"name":"account_id","in":"path"},{"required":false,"schema":{"type":"boolean","title":"Only Total","default":false},"name":"only_total","in":"query"},{"required":false,"schema":{"type":"boolean","title":"Include Total","default":false},"name":"include_total","in":"query"},{"required":false,"schema":{"type":"integer","title":"Limit"},"name":"limit","in":"query"},{"required":false,"schema":{"type":"integer","title":"Offset"},"name":"offset","in":"query"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeywordRequestWithGroup"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeywordOutWithGroupResp"}}}},"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/chromeextension/keywordgroupactions/{account_id}":{"post":{"tags":["chromeextension","keywords"],"summary":"This call adds keywords to a keyword group","operationId":"associate_dissociate_keywords_with_group_5_0_chromeextension_keywordgroupactions__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/AddRemoveKeywordsToGroupRequest"}}},"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/chromeextension/keywordgroups/{account_id}":{"get":{"tags":["chromeextension","keywords"],"summary":"This call returns a list of keywordgroups for a given account","operationId":"get_kw_groups_latest5_chromeextension_keywordgroups__account_id__get","parameters":[{"required":true,"schema":{"type":"integer","title":"Account Id"},"name":"account_id","in":"path"},{"required":false,"schema":{"type":"integer","title":"Limit"},"name":"limit","in":"query"},{"required":false,"schema":{"type":"integer","title":"Offset"},"name":"offset","in":"query"},{"required":false,"schema":{"type":"boolean","title":"Only Total","default":false},"name":"only_total","in":"query"},{"required":false,"schema":{"type":"boolean","title":"Include Total","default":false},"name":"include_total","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeywordGroupOutResp"}}}},"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/chromeextension/keywords/{account_id}":{"get":{"tags":["chromeextension","keywords"],"summary":"This call returns a list of keywords with kwg_id for a given account","operationId":"get_account_kw_kwg_id_latest5_chromeextension_keywords__account_id__get","parameters":[{"required":true,"schema":{"type":"integer","title":"Account Id"},"name":"account_id","in":"path"},{"required":false,"schema":{"type":"integer","title":"Limit"},"name":"limit","in":"query"},{"required":false,"schema":{"type":"integer","title":"Offset"},"name":"offset","in":"query"},{"required":false,"schema":{"type":"boolean","title":"Only Total","default":false},"name":"only_total","in":"query"},{"required":false,"schema":{"type":"boolean","title":"Include Total","default":false},"name":"include_total","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeywordOutWithGroupResp"}}}},"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":["chromeextension","keywords"],"summary":"This call returns a list of keyword with kwg_id for a given account","operationId":"get_account_kw_kwg_id_latest5_chromeextension_keywords__account_id__post","parameters":[{"required":true,"schema":{"type":"integer","title":"Account Id"},"name":"account_id","in":"path"},{"required":false,"schema":{"type":"boolean","title":"Only Total","default":false},"name":"only_total","in":"query"},{"required":false,"schema":{"type":"boolean","title":"Include Total","default":false},"name":"include_total","in":"query"},{"required":false,"schema":{"type":"integer","title":"Limit"},"name":"limit","in":"query"},{"required":false,"schema":{"type":"integer","title":"Offset"},"name":"offset","in":"query"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeywordRequestWithGroup"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeywordOutWithGroupResp"}}}},"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/chromeextension/keywordgroupactions/{account_id}":{"post":{"tags":["chromeextension","keywords"],"summary":"This call adds keywords to a keyword group","operationId":"associate_dissociate_keywords_with_group_latest5_chromeextension_keywordgroupactions__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/AddRemoveKeywordsToGroupRequest"}}},"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/domains":{"get":{"tags":["domains","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":["domains","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":["domains","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":["domains","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":["keywords","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":["keywords","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/activity/{group_name}":{"get":{"tags":["keywordgroups"],"summary":"This call returns list of keyword activities per account","operationId":"get_keywords_activity_5_0_objects_keywordgroups_activity__group_name__get","parameters":[{"required":true,"schema":{"type":"string","title":"Group Name"},"name":"group_name","in":"path"},{"required":false,"schema":{"type":"integer","maximum":202605.0,"minimum":202210.0,"title":"Start Year Month","default":202605},"name":"start_year_month","in":"query"},{"required":false,"schema":{"type":"integer","maximum":202606.0,"minimum":202211.0,"title":"End Year Month","default":202606},"name":"end_year_month","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/KeywordActivityOut"},"type":"array","title":"Response Get Keywords Activity 5 0 Objects Keywordgroups Activity Group Name 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":["keywordgroups","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":["keywords","keywordgroups","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":["keywords","keywordgroups","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/activity/{group_name}":{"get":{"tags":["keywordgroups"],"summary":"This call returns list of keyword activities per account","operationId":"get_keywords_activity_latest5_objects_keywordgroups_activity__group_name__get","parameters":[{"required":true,"schema":{"type":"string","title":"Group Name"},"name":"group_name","in":"path"},{"required":false,"schema":{"type":"integer","maximum":202605.0,"minimum":202210.0,"title":"Start Year Month","default":202605},"name":"start_year_month","in":"query"},{"required":false,"schema":{"type":"integer","maximum":202606.0,"minimum":202211.0,"title":"End Year Month","default":202606},"name":"end_year_month","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/KeywordActivityOut"},"type":"array","title":"Response Get Keywords Activity Latest5 Objects Keywordgroups Activity Group Name 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}":{"get":{"tags":["keywordgroups","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":["keywords","keywordgroups","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":["keywords","keywordgroups","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/organizations/self":{"get":{"tags":["organizations"],"summary":"This call returns the details of this user's organization","operationId":"organizations_self_5_0_objects_organizations_self_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationOut"}}}}},"security":[{"http_basic":[]},{"forwarded_http_basic":[]},{"session_cookie":[]},{"session_header":[]},{"api_token_header":[]},{"bearer_token":[]}]}},"/latest5/objects/organizations/self":{"get":{"tags":["organizations"],"summary":"This call returns the details of this user's organization","operationId":"organizations_self_latest5_objects_organizations_self_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationOut"}}}}},"security":[{"http_basic":[]},{"forwarded_http_basic":[]},{"session_cookie":[]},{"session_header":[]},{"api_token_header":[]},{"bearer_token":[]}]}},"/5.0/organizations/objects/users":{"get":{"tags":["organizations"],"summary":"This call returns the details of all active users in this organization with their accounts","operationId":"get_users_5_0_organizations_objects_users_get","parameters":[{"description":"The number of users to return per page.","required":false,"schema":{"type":"integer","exclusiveMinimum":0.0,"title":"Limit","description":"The number of users to return per page.","default":10},"name":"limit","in":"query"},{"description":"The number of users to skip before starting to return.","required":false,"schema":{"type":"integer","minimum":0.0,"title":"Offset","description":"The number of users to skip before starting to return.","default":0},"name":"offset","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationUsersOutput"}}}},"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/organizations/objects/accounts":{"get":{"tags":["organizations"],"summary":"This call returns the details of all accounts in this organization","operationId":"organizations_bulk_accounts_5_0_organizations_objects_accounts_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/OrgAccountDetailOut"},"type":"array","title":"Response Organizations Bulk Accounts 5 0 Organizations Objects Accounts Get"}}}}},"security":[{"http_basic":[]},{"forwarded_http_basic":[]},{"session_cookie":[]},{"session_header":[]},{"api_token_header":[]},{"bearer_token":[]}]}},"/latest5/organizations/objects/users":{"get":{"tags":["organizations"],"summary":"This call returns the details of all active users in this organization with their accounts","operationId":"get_users_latest5_organizations_objects_users_get","parameters":[{"description":"The number of users to return per page.","required":false,"schema":{"type":"integer","exclusiveMinimum":0.0,"title":"Limit","description":"The number of users to return per page.","default":10},"name":"limit","in":"query"},{"description":"The number of users to skip before starting to return.","required":false,"schema":{"type":"integer","minimum":0.0,"title":"Offset","description":"The number of users to skip before starting to return.","default":0},"name":"offset","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationUsersOutput"}}}},"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/organizations/objects/accounts":{"get":{"tags":["organizations"],"summary":"This call returns the details of all accounts in this organization","operationId":"organizations_bulk_accounts_latest5_organizations_objects_accounts_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/OrgAccountDetailOut"},"type":"array","title":"Response Organizations Bulk Accounts Latest5 Organizations Objects Accounts Get"}}}}},"security":[{"http_basic":[]},{"forwarded_http_basic":[]},{"session_cookie":[]},{"session_header":[]},{"api_token_header":[]},{"bearer_token":[]}]}},"/5.0/organizations/marketinsights/data/{date_id}":{"get":{"tags":["marketinsights"],"summary":"Returns the list of reports available for downloading.","description":"Endpoint returns list of documents available for downloading.","operationId":"market_insights_data_request_5_0_organizations_marketinsights_data__date_id__get","parameters":[{"description":"Date in YYYYMM format","required":true,"schema":{"type":"integer","maximum":204001.0,"exclusiveMinimum":202000.0,"title":"Date Id","description":"Date in YYYYMM format"},"example":202109,"name":"date_id","in":"path"}],"responses":{"200":{"description":"List of reports.","content":{"application/json":{"schema":{},"example":{"total_reports":5,"total_size_bytes":1249080942,"reports":[{"name":"customers-000000000000","name_url_encoded":"customers-000000000000","size":160},{"name":"search_volumes-000000000000","name_url_encoded":"search_volumes-000000000000","size":151920182},{"name":"serps-000000000000","name_url_encoded":"serps-000000000000","size":365770017},{"name":"serps-000000000001","name_url_encoded":"serps-000000000001","size":365682375},{"name":"serps-000000000002","name_url_encoded":"serps-000000000002","size":365708208}]}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"example":{"status":"date_id should be in YYYYMM format. '20210901' was provided"}}}}},"security":[{"http_basic":[]},{"forwarded_http_basic":[]},{"session_cookie":[]},{"session_header":[]},{"api_token_header":[]},{"bearer_token":[]}]}},"/5.0/organizations/marketinsights/data/{date_id}/{report_name}":{"get":{"tags":["marketinsights"],"summary":"Returns market insight report in csv format.","description":"Endpoint streams chosen csv report file. File chunks will be compressed using gzip\nif \"gzip\" is added to \"Accept-Encoding\" header of the request.","operationId":"market_insights_data_request_5_0_organizations_marketinsights_data__date_id___report_name__get","parameters":[{"description":"Date in YYYYMM format","required":true,"schema":{"type":"integer","maximum":204001.0,"exclusiveMinimum":202000.0,"title":"Date Id","description":"Date in YYYYMM format"},"example":202109,"name":"date_id","in":"path"},{"description":"URL encoded report name","required":true,"schema":{"type":"string","title":"Report Name","description":"URL encoded report name"},"example":"search_volumes-000000000000","name":"report_name","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}},"text/csv":{"example":"keyword_local,keyword_language,keyword_country,date,search_volume\nkeyword1,English,United Kingdom,20200201,14800\nkeyword2,English,United Kingdom,20200201,14800\nkeyword3,English,United Kingdom,20200201,135000"}}},"400":{"description":"Bad Request","content":{"application/json":{"example":{"status":"Report 'wrong_report_name' for 202109 was not found"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"example":{"status":"date_id should be in YYYYMM format. '20210901' was provided"}}}}},"security":[{"http_basic":[]},{"forwarded_http_basic":[]},{"session_cookie":[]},{"session_header":[]},{"api_token_header":[]},{"bearer_token":[]}]}},"/latest5/organizations/marketinsights/data/{date_id}":{"get":{"tags":["marketinsights"],"summary":"Returns the list of reports available for downloading.","description":"Endpoint returns list of documents available for downloading.","operationId":"market_insights_data_request_latest5_organizations_marketinsights_data__date_id__get","parameters":[{"description":"Date in YYYYMM format","required":true,"schema":{"type":"integer","maximum":204001.0,"exclusiveMinimum":202000.0,"title":"Date Id","description":"Date in YYYYMM format"},"example":202109,"name":"date_id","in":"path"}],"responses":{"200":{"description":"List of reports.","content":{"application/json":{"schema":{},"example":{"total_reports":5,"total_size_bytes":1249080942,"reports":[{"name":"customers-000000000000","name_url_encoded":"customers-000000000000","size":160},{"name":"search_volumes-000000000000","name_url_encoded":"search_volumes-000000000000","size":151920182},{"name":"serps-000000000000","name_url_encoded":"serps-000000000000","size":365770017},{"name":"serps-000000000001","name_url_encoded":"serps-000000000001","size":365682375},{"name":"serps-000000000002","name_url_encoded":"serps-000000000002","size":365708208}]}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"example":{"status":"date_id should be in YYYYMM format. '20210901' was provided"}}}}},"security":[{"http_basic":[]},{"forwarded_http_basic":[]},{"session_cookie":[]},{"session_header":[]},{"api_token_header":[]},{"bearer_token":[]}]}},"/latest5/organizations/marketinsights/data/{date_id}/{report_name}":{"get":{"tags":["marketinsights"],"summary":"Returns market insight report in csv format.","description":"Endpoint streams chosen csv report file. File chunks will be compressed using gzip\nif \"gzip\" is added to \"Accept-Encoding\" header of the request.","operationId":"market_insights_data_request_latest5_organizations_marketinsights_data__date_id___report_name__get","parameters":[{"description":"Date in YYYYMM format","required":true,"schema":{"type":"integer","maximum":204001.0,"exclusiveMinimum":202000.0,"title":"Date Id","description":"Date in YYYYMM format"},"example":202109,"name":"date_id","in":"path"},{"description":"URL encoded report name","required":true,"schema":{"type":"string","title":"Report Name","description":"URL encoded report name"},"example":"search_volumes-000000000000","name":"report_name","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}},"text/csv":{"example":"keyword_local,keyword_language,keyword_country,date,search_volume\nkeyword1,English,United Kingdom,20200201,14800\nkeyword2,English,United Kingdom,20200201,14800\nkeyword3,English,United Kingdom,20200201,135000"}}},"400":{"description":"Bad Request","content":{"application/json":{"example":{"status":"Report 'wrong_report_name' for 202109 was not found"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"example":{"status":"date_id should be in YYYYMM format. '20210901' was provided"}}}}},"security":[{"http_basic":[]},{"forwarded_http_basic":[]},{"session_cookie":[]},{"session_header":[]},{"api_token_header":[]},{"bearer_token":[]}]}},"/5.0/objects/query/{account_id}":{"post":{"tags":["budd","query","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":["budd","query","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":["searchengines","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":["searchengines","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":["legacy","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":["legacy","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":["legacy","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":["legacy","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":["legacy","keywordgroups","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":{"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","keywords","keywordgroups","accounts"],"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","keywordgroups","accounts"],"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","keywords","keywordgroups","accounts"],"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","domains","accounts"],"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","domains","accounts"],"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","domains","accounts"],"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","domains","accounts"],"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","domains","competitors","accounts"],"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","domains","competitors","accounts"],"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","keywords","accounts"],"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","keywords","accounts"],"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","time","accounts"],"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","time","accounts"],"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","datacube_searchengines","accounts"],"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","datacube_searchengines","accounts"],"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","searchengines","accounts"],"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","searchengines","accounts"],"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","query","accounts"],"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","query","accounts"],"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","query","accounts"],"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","query","accounts"],"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","qa"],"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","qa"],"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":[]}]}},"/5.0/organizations/objects/recommendations":{"get":{"tags":["organizations"],"summary":"This call returns a list of recommendations for accounts of the user's organization.","operationId":"get_recommendation_5_0_organizations_objects_recommendations_get","parameters":[{"required":true,"schema":{"type":"integer","title":"Time Value"},"name":"time_value","in":"query"},{"required":true,"schema":{"$ref":"#/components/schemas/GeogorianTimeTimeStringType"},"name":"time_frequency","in":"query"},{"description":"Keyword group names to filter recommendations","required":false,"schema":{"items":{"type":"string"},"type":"array","title":"Kwg Name","description":"Keyword group names to filter recommendations"},"name":"kwg_name","in":"query"},{"required":false,"schema":{"type":"integer","title":"Limit","default":100},"name":"limit","in":"query"},{"required":false,"schema":{"type":"integer","title":"Offset","default":0},"name":"offset","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/RecommendationOut"},"type":"array","title":"Response Get Recommendation 5 0 Organizations Objects Recommendations 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/organizations/objects/pbr_page_keyword_pop_up/{account_id}":{"post":{"tags":["recommendations"],"summary":"This call returns details of keyword recommendation","operationId":"get_keyword_recommendation_details_5_0_organizations_objects_pbr_page_keyword_pop_up__account_id__post","parameters":[{"required":true,"schema":{"type":"integer","title":"Account Id"},"name":"account_id","in":"path"},{"required":false,"schema":{"type":"integer","title":"Limit"},"name":"limit","in":"query"},{"required":false,"schema":{"type":"integer","title":"Offset"},"name":"offset","in":"query"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecommendationKwListRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecommendationKwListResponse"}}}},"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/organizations/objects/pbr_keywords/{account_id}":{"post":{"tags":["recommendations"],"summary":"This endpoint allows change priority of keywords","operationId":"change_keyword_priority_5_0_organizations_objects_pbr_keywords__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/RecommendationKwChangePriorityRequest"}}},"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/organizations/objects/get_tracked_pages/{account_id}":{"get":{"tags":["recommendations"],"summary":"This call returns list of tracked pages","operationId":"get_tracked_pages_5_0_organizations_objects_get_tracked_pages__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":{}}}},"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/organizations/objects/recommendations":{"get":{"tags":["organizations"],"summary":"This call returns a list of recommendations for accounts of the user's organization.","operationId":"get_recommendation_latest5_organizations_objects_recommendations_get","parameters":[{"required":true,"schema":{"type":"integer","title":"Time Value"},"name":"time_value","in":"query"},{"required":true,"schema":{"$ref":"#/components/schemas/GeogorianTimeTimeStringType"},"name":"time_frequency","in":"query"},{"description":"Keyword group names to filter recommendations","required":false,"schema":{"items":{"type":"string"},"type":"array","title":"Kwg Name","description":"Keyword group names to filter recommendations"},"name":"kwg_name","in":"query"},{"required":false,"schema":{"type":"integer","title":"Limit","default":100},"name":"limit","in":"query"},{"required":false,"schema":{"type":"integer","title":"Offset","default":0},"name":"offset","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/RecommendationOut"},"type":"array","title":"Response Get Recommendation Latest5 Organizations Objects Recommendations 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/organizations/objects/pbr_page_keyword_pop_up/{account_id}":{"post":{"tags":["recommendations"],"summary":"This call returns details of keyword recommendation","operationId":"get_keyword_recommendation_details_latest5_organizations_objects_pbr_page_keyword_pop_up__account_id__post","parameters":[{"required":true,"schema":{"type":"integer","title":"Account Id"},"name":"account_id","in":"path"},{"required":false,"schema":{"type":"integer","title":"Limit"},"name":"limit","in":"query"},{"required":false,"schema":{"type":"integer","title":"Offset"},"name":"offset","in":"query"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecommendationKwListRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RecommendationKwListResponse"}}}},"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/organizations/objects/pbr_keywords/{account_id}":{"post":{"tags":["recommendations"],"summary":"This endpoint allows change priority of keywords","operationId":"change_keyword_priority_latest5_organizations_objects_pbr_keywords__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/RecommendationKwChangePriorityRequest"}}},"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/organizations/objects/get_tracked_pages/{account_id}":{"get":{"tags":["recommendations"],"summary":"This call returns list of tracked pages","operationId":"get_tracked_pages_latest5_organizations_objects_get_tracked_pages__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":{}}}},"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/serp_features/people_also_ask_historical":{"post":{"tags":["Serp Features","people_also_ask"],"summary":"This call returns a list of questions asked for the keyword historically for the past n-weeks","operationId":"get_keyword_linked_questions_5_0_objects_serp_features_people_also_ask_historical_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PeopleAlsoAskHistoricalIn"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PeopleAlsoAskHistoricalOut"}}}},"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/serp_features/people_also_ask_live":{"post":{"tags":["Serp Features","people_also_ask"],"summary":"This call returns a list of questions asked for the keyword as a live call","operationId":"get_live_questions_5_0_objects_serp_features_people_also_ask_live_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PeopleAlsoAskLiveIn"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PeopleAlsoAskLiveOut"}}}},"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/serp_features/people_also_ask_chatgpt":{"post":{"tags":["Serp Features","people_also_ask"],"summary":"This call returns a list of questions asked for the keyword via chatgpt","operationId":"get_live_questions_5_0_objects_serp_features_people_also_ask_chatgpt_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PeopleAlsoAskChatgptIn"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PeopleAlsoAskChatgptOut"}}}},"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/serp_features/people_also_ask":{"post":{"tags":["Serp Features","people_also_ask"],"summary":"This call returns a list of questions asked optionally via historic means, on demand live call and via chatgpt","operationId":"get_live_questions_5_0_objects_serp_features_people_also_ask_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PeopleAlsoAskIn"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PeopleAlsoAskOut"}}}},"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/serp_features/people_also_ask_historical":{"post":{"tags":["Serp Features","people_also_ask"],"summary":"This call returns a list of questions asked for the keyword historically for the past n-weeks","operationId":"get_keyword_linked_questions_latest5_objects_serp_features_people_also_ask_historical_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PeopleAlsoAskHistoricalIn"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PeopleAlsoAskHistoricalOut"}}}},"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/serp_features/people_also_ask_live":{"post":{"tags":["Serp Features","people_also_ask"],"summary":"This call returns a list of questions asked for the keyword as a live call","operationId":"get_live_questions_latest5_objects_serp_features_people_also_ask_live_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PeopleAlsoAskLiveIn"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PeopleAlsoAskLiveOut"}}}},"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/serp_features/people_also_ask_chatgpt":{"post":{"tags":["Serp Features","people_also_ask"],"summary":"This call returns a list of questions asked for the keyword via chatgpt","operationId":"get_live_questions_latest5_objects_serp_features_people_also_ask_chatgpt_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PeopleAlsoAskChatgptIn"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PeopleAlsoAskChatgptOut"}}}},"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/serp_features/people_also_ask":{"post":{"tags":["Serp Features","people_also_ask"],"summary":"This call returns a list of questions asked optionally via historic means, on demand live call and via chatgpt","operationId":"get_live_questions_latest5_objects_serp_features_people_also_ask_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PeopleAlsoAskIn"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PeopleAlsoAskOut"}}}},"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/organizations/objects/site_audit_page_group":{"post":{"tags":["organizations"],"summary":"This call returns a list of recommendations for accounts of the user's organization.","operationId":"get_site_audit_page_group_details_5_0_organizations_objects_site_audit_page_group_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteAuditPageGroupIn"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteAuditPageGroupOut"}}}},"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/organizations/objects/site_audit_crawl_report":{"post":{"tags":["organizations"],"summary":"This call returns a list of recommendations for accounts of the user's organization.","operationId":"get_site_audit_crawl_report_5_0_organizations_objects_site_audit_crawl_report_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteAuditReportIn"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteAuditReportOut"}}}},"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/organizations/objects/site_audit_page_group":{"post":{"tags":["organizations"],"summary":"This call returns a list of recommendations for accounts of the user's organization.","operationId":"get_site_audit_page_group_details_latest5_organizations_objects_site_audit_page_group_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteAuditPageGroupIn"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteAuditPageGroupOut"}}}},"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/organizations/objects/site_audit_crawl_report":{"post":{"tags":["organizations"],"summary":"This call returns a list of recommendations for accounts of the user's organization.","operationId":"get_site_audit_crawl_report_latest5_organizations_objects_site_audit_crawl_report_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteAuditReportIn"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteAuditReportOut"}}}},"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/instant/keywordIdeas/{organization_id}/{request_id}":{"post":{"tags":["instant"],"summary":"Get Kw Ideas Result","description":"This endpoint return result","operationId":"get_kw_ideas_result_5_0_instant_keywordIdeas__organization_id___request_id__post","parameters":[{"required":true,"schema":{"type":"integer","title":"Organization Id"},"name":"organization_id","in":"path"},{"required":true,"schema":{"type":"string","title":"Request Id"},"name":"request_id","in":"path"},{"required":false,"schema":{"type":"boolean","title":"Only Total","default":false},"name":"only_total","in":"query"},{"required":false,"schema":{"type":"boolean","title":"Include Total","default":false},"name":"include_total","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KwIdeasHistoryOut"}}}},"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/instant/keywordIdeas/{organization_id}":{"post":{"tags":["instant"],"summary":"Submit Kw For Ideas","description":"This endpoint receive keywords for ideas","operationId":"submit_kw_for_ideas_5_0_instant_keywordIdeas__organization_id__post","parameters":[{"required":true,"schema":{"type":"integer","title":"Organization Id"},"name":"organization_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":[]}]}},"/5.0/instant/webhook/{provider}/kw_ideas/{request_id}":{"post":{"tags":["instant","webhook"],"summary":"Process Webhook","description":"This endpoint handle webhook from oxylabs","operationId":"process_webhook_5_0_instant_webhook__provider__kw_ideas__request_id__post","parameters":[{"required":true,"schema":{"type":"string","title":"Provider"},"name":"provider","in":"path"},{"required":true,"schema":{"type":"string","title":"Request Id"},"name":"request_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","title":"Payload"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/latest5/instant/keywordIdeas/{organization_id}/{request_id}":{"post":{"tags":["instant"],"summary":"Get Kw Ideas Result","description":"This endpoint return result","operationId":"get_kw_ideas_result_latest5_instant_keywordIdeas__organization_id___request_id__post","parameters":[{"required":true,"schema":{"type":"integer","title":"Organization Id"},"name":"organization_id","in":"path"},{"required":true,"schema":{"type":"string","title":"Request Id"},"name":"request_id","in":"path"},{"required":false,"schema":{"type":"boolean","title":"Only Total","default":false},"name":"only_total","in":"query"},{"required":false,"schema":{"type":"boolean","title":"Include Total","default":false},"name":"include_total","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KwIdeasHistoryOut"}}}},"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/instant/keywordIdeas/{organization_id}":{"post":{"tags":["instant"],"summary":"Submit Kw For Ideas","description":"This endpoint receive keywords for ideas","operationId":"submit_kw_for_ideas_latest5_instant_keywordIdeas__organization_id__post","parameters":[{"required":true,"schema":{"type":"integer","title":"Organization Id"},"name":"organization_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":[]}]}},"/latest5/instant/webhook/{provider}/kw_ideas/{request_id}":{"post":{"tags":["instant","webhook"],"summary":"Process Webhook","description":"This endpoint handle webhook from oxylabs","operationId":"process_webhook_latest5_instant_webhook__provider__kw_ideas__request_id__post","parameters":[{"required":true,"schema":{"type":"string","title":"Provider"},"name":"provider","in":"path"},{"required":true,"schema":{"type":"string","title":"Request Id"},"name":"request_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","title":"Payload"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/5.0/web_vitals/{account_id}/{device_type}":{"post":{"tags":["web_vitals"],"summary":"Save Site Info","description":"This saves the web vitals data for the user","operationId":"save_site_info_5_0_web_vitals__account_id___device_type__post","parameters":[{"required":true,"schema":{"type":"integer","title":"Account Id"},"name":"account_id","in":"path"},{"required":true,"schema":{"type":"string","title":"Device Type"},"name":"device_type","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","title":"Payload"}}},"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/web_vitals/results/{account_id}/{device_type}":{"post":{"tags":["web_vitals"],"summary":"Get Site Info","description":"This returns the web vitals data for the user","operationId":"get_site_info_5_0_web_vitals_results__account_id___device_type__post","parameters":[{"required":true,"schema":{"type":"integer","title":"Account Id"},"name":"account_id","in":"path"},{"required":true,"schema":{"type":"string","title":"Device Type"},"name":"device_type","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetWebVitalsData"}}},"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/web_vitals/{account_id}/{device_type}":{"post":{"tags":["web_vitals"],"summary":"Save Site Info","description":"This saves the web vitals data for the user","operationId":"save_site_info_latest5_web_vitals__account_id___device_type__post","parameters":[{"required":true,"schema":{"type":"integer","title":"Account Id"},"name":"account_id","in":"path"},{"required":true,"schema":{"type":"string","title":"Device Type"},"name":"device_type","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","title":"Payload"}}},"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/web_vitals/results/{account_id}/{device_type}":{"post":{"tags":["web_vitals"],"summary":"Get Site Info","description":"This returns the web vitals data for the user","operationId":"get_site_info_latest5_web_vitals_results__account_id___device_type__post","parameters":[{"required":true,"schema":{"type":"integer","title":"Account Id"},"name":"account_id","in":"path"},{"required":true,"schema":{"type":"string","title":"Device Type"},"name":"device_type","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetWebVitalsData"}}},"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/user_settings/recommendations/{account_id}":{"get":{"tags":["user_settings"],"summary":"This call return the user settings for recommendations","operationId":"get_siteaudit_settings_5_0_user_settings_recommendations__account_id__get","parameters":[{"required":true,"schema":{"type":"string","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":[]}]}},"/5.0/user_settings/seteaudit/{account_id}/{preset_id}":{"get":{"tags":["user_settings"],"summary":"This call return the user settings for site audit","operationId":"get_siteaudit_settings_5_0_user_settings_seteaudit__account_id___preset_id__get","parameters":[{"required":true,"schema":{"type":"string","title":"Account Id"},"name":"account_id","in":"path"},{"required":true,"schema":{"type":"string","title":"Preset Id"},"name":"preset_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":[]}]}},"/latest5/user_settings/recommendations/{account_id}":{"get":{"tags":["user_settings"],"summary":"This call return the user settings for recommendations","operationId":"get_siteaudit_settings_latest5_user_settings_recommendations__account_id__get","parameters":[{"required":true,"schema":{"type":"string","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":[]}]}},"/latest5/user_settings/seteaudit/{account_id}/{preset_id}":{"get":{"tags":["user_settings"],"summary":"This call return the user settings for site audit","operationId":"get_siteaudit_settings_latest5_user_settings_seteaudit__account_id___preset_id__get","parameters":[{"required":true,"schema":{"type":"string","title":"Account Id"},"name":"account_id","in":"path"},{"required":true,"schema":{"type":"string","title":"Preset Id"},"name":"preset_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":[]}]}},"/5.0/autopilot/foundations/1.0/update_certificate":{"post":{"tags":["autopilot"],"summary":"This method allows customer to manually their SSL certificate.","description":"This endpoint allows customer to manually update their SSL certificate.","operationId":"apf_update_certificate_5_0_autopilot_foundations_1_0_update_certificate_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutoPilotFoundationsCertificate"}}},"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/autopilot/foundations/1.0/update_certificate":{"post":{"tags":["autopilot"],"summary":"This method allows customer to manually their SSL certificate.","description":"This endpoint allows customer to manually update their SSL certificate.","operationId":"apf_update_certificate_latest5_autopilot_foundations_1_0_update_certificate_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutoPilotFoundationsCertificate"}}},"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":[]}]}},"/ap/1.0/apm/refresh_cache":{"post":{"tags":["autopilot"],"summary":"This method allows cached image(s) given a given image URL or folder to be refreshed.","description":"This method delegates to marvel-admin's marveltool-api (running in tomcat) to refresh cached image(s) given image URL or folder.\nFor urlType 'folder', only top-level images will be refreshed, images on sub-folder(s) remains.","operationId":"apm_clear_cache_ap_1_0_apm_refresh_cache_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutoPilotCacheClearIn"}}},"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":[]}]}},"/ap/1.0/apm/invalidate_cache":{"post":{"tags":["autopilot"],"summary":"This method allows cached image(s) to be invalidated from CDN cache.","description":"This method delegates to marvel-admin's marveltool-api (running in tomcat) to invalidate ALL cached image(s) for the entire account.\n\n@type request: HttpRequest\n@param request: request to the view\n@rtype: HTTPResponse\n@return: response for the view","operationId":"apm_invalidate_cache_ap_1_0_apm_invalidate_cache_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutoPilotCacheInvalidateIn"}}},"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/chrome_extension/overview/images":{"post":{"tags":["chrome_extension","Chrome Extension Overview"],"summary":"Get Image tags Alt texts","operationId":"images_5_0_chrome_extension_overview_images_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImagesInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"type":"string"},"type":"array","title":"Response Images 5 0 Chrome Extension Overview Images Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"http_basic":[]},{"forwarded_http_basic":[]},{"session_cookie":[]},{"session_header":[]}]}},"/5.0/chrome_extension/overview/content":{"post":{"tags":["chrome_extension","Chrome Extension Overview"],"summary":"Get Page Contents","operationId":"content_5_0_chrome_extension_overview_content_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Content"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"http_basic":[]},{"forwarded_http_basic":[]},{"session_cookie":[]},{"session_header":[]}]}},"/5.0/chrome_extension/overview/web_vitals":{"get":{"tags":["chrome_extension","Chrome Extension Overview"],"summary":"Get Web Vitals","operationId":"web_vitals_5_0_chrome_extension_overview_web_vitals_get","parameters":[{"required":true,"schema":{"type":"string","title":"Url"},"name":"url","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebVitals"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"http_basic":[]},{"forwarded_http_basic":[]},{"session_cookie":[]},{"session_header":[]}]}},"/5.0/chrome_extension/keywords/track_keywords":{"post":{"tags":["chrome_extension","Chrome Extension Keywords"],"summary":"Track Keywords","operationId":"track_keywords_5_0_chrome_extension_keywords_track_keywords_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrackKeywordsInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeywordGroups"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"http_basic":[]},{"forwarded_http_basic":[]},{"session_cookie":[]},{"session_header":[]}]}},"/5.0/chrome_extension/keywords/compare_domains":{"post":{"tags":["chrome_extension","Chrome Extension Keywords"],"summary":"Compare Domains","operationId":"compare_domains_5_0_chrome_extension_keywords_compare_domains_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainComparisonInput"}}},"required":true},"responses":{"200":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"http_basic":[]},{"forwarded_http_basic":[]},{"session_cookie":[]},{"session_header":[]}]}},"/5.0/chrome_extension/keywords/research_keywords":{"post":{"tags":["chrome_extension","Chrome Extension Keywords"],"summary":"Research Keywords","operationId":"research_keywords_5_0_chrome_extension_keywords_research_keywords_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchKeywordsInput"}}},"required":true},"responses":{"200":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"http_basic":[]},{"forwarded_http_basic":[]},{"session_cookie":[]},{"session_header":[]}]}},"/latest5/chrome_extension/overview/images":{"post":{"tags":["chrome_extension","Chrome Extension Overview"],"summary":"Get Image tags Alt texts","operationId":"images_latest5_chrome_extension_overview_images_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImagesInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"type":"string"},"type":"array","title":"Response Images Latest5 Chrome Extension Overview Images Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"http_basic":[]},{"forwarded_http_basic":[]},{"session_cookie":[]},{"session_header":[]}]}},"/latest5/chrome_extension/overview/content":{"post":{"tags":["chrome_extension","Chrome Extension Overview"],"summary":"Get Page Contents","operationId":"content_latest5_chrome_extension_overview_content_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Content"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"http_basic":[]},{"forwarded_http_basic":[]},{"session_cookie":[]},{"session_header":[]}]}},"/latest5/chrome_extension/overview/web_vitals":{"get":{"tags":["chrome_extension","Chrome Extension Overview"],"summary":"Get Web Vitals","operationId":"web_vitals_latest5_chrome_extension_overview_web_vitals_get","parameters":[{"required":true,"schema":{"type":"string","title":"Url"},"name":"url","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebVitals"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"http_basic":[]},{"forwarded_http_basic":[]},{"session_cookie":[]},{"session_header":[]}]}},"/latest5/chrome_extension/keywords/track_keywords":{"post":{"tags":["chrome_extension","Chrome Extension Keywords"],"summary":"Track Keywords","operationId":"track_keywords_latest5_chrome_extension_keywords_track_keywords_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrackKeywordsInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KeywordGroups"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"http_basic":[]},{"forwarded_http_basic":[]},{"session_cookie":[]},{"session_header":[]}]}},"/latest5/chrome_extension/keywords/compare_domains":{"post":{"tags":["chrome_extension","Chrome Extension Keywords"],"summary":"Compare Domains","operationId":"compare_domains_latest5_chrome_extension_keywords_compare_domains_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainComparisonInput"}}},"required":true},"responses":{"200":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"http_basic":[]},{"forwarded_http_basic":[]},{"session_cookie":[]},{"session_header":[]}]}},"/latest5/chrome_extension/keywords/research_keywords":{"post":{"tags":["chrome_extension","Chrome Extension Keywords"],"summary":"Research Keywords","operationId":"research_keywords_latest5_chrome_extension_keywords_research_keywords_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchKeywordsInput"}}},"required":true},"responses":{"200":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"http_basic":[]},{"forwarded_http_basic":[]},{"session_cookie":[]},{"session_header":[]}]}},"/5.0/objects/backlinks/{account_id}":{"get":{"tags":["backlinks"],"summary":"This call returns backlinks url and page authority score for given account id","operationId":"get_backlink_url_score_5_0_objects_backlinks__account_id__get","parameters":[{"required":true,"schema":{"type":"integer","title":"Account Id"},"name":"account_id","in":"path"},{"description":"The number of backlinks to return per page.","required":false,"schema":{"type":"integer","exclusiveMinimum":0.0,"title":"Limit","description":"The number of backlinks to return per page.","default":5000},"name":"limit","in":"query"},{"description":"The number of backlinks to skip before starting to return.","required":false,"schema":{"type":"integer","minimum":0.0,"title":"Offset","description":"The number of backlinks to skip before starting to return.","default":0},"name":"offset","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/BacklinksOut"},"type":"array","title":"Response Get Backlink Url Score 5 0 Objects Backlinks 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/backlinks/{account_id}":{"get":{"tags":["backlinks"],"summary":"This call returns backlinks url and page authority score for given account id","operationId":"get_backlink_url_score_latest5_objects_backlinks__account_id__get","parameters":[{"required":true,"schema":{"type":"integer","title":"Account Id"},"name":"account_id","in":"path"},{"description":"The number of backlinks to return per page.","required":false,"schema":{"type":"integer","exclusiveMinimum":0.0,"title":"Limit","description":"The number of backlinks to return per page.","default":5000},"name":"limit","in":"query"},{"description":"The number of backlinks to skip before starting to return.","required":false,"schema":{"type":"integer","minimum":0.0,"title":"Offset","description":"The number of backlinks to skip before starting to return.","default":0},"name":"offset","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/BacklinksOut"},"type":"array","title":"Response Get Backlink Url Score Latest5 Objects Backlinks 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/marketo/ping":{"get":{"tags":["marketo","ping"],"summary":"This is simple ping api","operationId":"ping_5_0_marketo_ping_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/5.0/marketo/page_cache":{"post":{"tags":["marketo","page cache"],"summary":"This API retrieves page html cache from gcs for a given url","operationId":"get_page_cache_5_0_marketo_page_cache_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketoCacheRequest"}}},"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/marketo/page_crawl":{"post":{"tags":["marketo","page crawl"],"summary":"This API retrieves page html by crawling a given url","operationId":"crawl_page_content_5_0_marketo_page_crawl_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketoCacheRequest"}}},"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/marketo/top_pages":{"post":{"tags":["marketo","top pages"],"summary":"This API retrieves top N(default 1000) pages for a given base domain","operationId":"get_top_pages_5_0_marketo_top_pages_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketoTopPagesRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketoTopPagesResponse"}}}},"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/marketo/top_keywords_per_page":{"post":{"tags":["marketo","top keywords per page"],"summary":"This API retrieves top N(default 5) keywords for a given page","operationId":"get_top_keywords_per_page_5_0_marketo_top_keywords_per_page_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketoTopKeywordsPerPageRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketoTopKeywordsPerPageResponse"}}}},"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/marketo/top_keywords":{"post":{"tags":["marketo","top keywords for a domain"],"summary":"This API retrieves top N(default 100) keywords for a given domain","operationId":"get_top_keywords_per_domain_5_0_marketo_top_keywords_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketoTopKeywordsPerDomainRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketoTopKeywordsPerDomainResponse"}}}},"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/marketo/paa_per_keyword":{"post":{"tags":["marketo","paa per keyword"],"summary":"This API retrieves top N(default 4) PAA questions for a given keyword","operationId":"get_paa_per_keyword_5_0_marketo_paa_per_keyword_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketoPaaRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketoPaaResponse"}}}},"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/marketo/ping":{"get":{"tags":["marketo","ping"],"summary":"This is simple ping api","operationId":"ping_latest5_marketo_ping_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/latest5/marketo/page_cache":{"post":{"tags":["marketo","page cache"],"summary":"This API retrieves page html cache from gcs for a given url","operationId":"get_page_cache_latest5_marketo_page_cache_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketoCacheRequest"}}},"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/marketo/page_crawl":{"post":{"tags":["marketo","page crawl"],"summary":"This API retrieves page html by crawling a given url","operationId":"crawl_page_content_latest5_marketo_page_crawl_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketoCacheRequest"}}},"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/marketo/top_pages":{"post":{"tags":["marketo","top pages"],"summary":"This API retrieves top N(default 1000) pages for a given base domain","operationId":"get_top_pages_latest5_marketo_top_pages_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketoTopPagesRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketoTopPagesResponse"}}}},"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/marketo/top_keywords_per_page":{"post":{"tags":["marketo","top keywords per page"],"summary":"This API retrieves top N(default 5) keywords for a given page","operationId":"get_top_keywords_per_page_latest5_marketo_top_keywords_per_page_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketoTopKeywordsPerPageRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketoTopKeywordsPerPageResponse"}}}},"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/marketo/top_keywords":{"post":{"tags":["marketo","top keywords for a domain"],"summary":"This API retrieves top N(default 100) keywords for a given domain","operationId":"get_top_keywords_per_domain_latest5_marketo_top_keywords_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketoTopKeywordsPerDomainRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketoTopKeywordsPerDomainResponse"}}}},"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/marketo/paa_per_keyword":{"post":{"tags":["marketo","paa per keyword"],"summary":"This API retrieves top N(default 4) PAA questions for a given keyword","operationId":"get_paa_per_keyword_latest5_marketo_paa_per_keyword_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketoPaaRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketoPaaResponse"}}}},"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/dataset/ping":{"get":{"tags":["dataset","ping"],"summary":"This is simple ping api","operationId":"ping_5_0_dataset_ping_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/5.0/dataset/page_cache":{"post":{"tags":["dataset","page cache"],"summary":"This API retrieves page html cache from gcs for a given url","operationId":"get_page_cache_5_0_dataset_page_cache_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketoCacheRequest"}}},"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/dataset/page_crawl":{"post":{"tags":["dataset","page crawl"],"summary":"This API retrieves page html by crawling a given url","operationId":"crawl_page_content_5_0_dataset_page_crawl_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketoCacheRequest"}}},"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/dataset/top_pages":{"post":{"tags":["dataset","top pages"],"summary":"This API retrieves top N(default 1000) pages for a given base domain","operationId":"get_top_pages_5_0_dataset_top_pages_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketoTopPagesRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketoTopPagesResponse"}}}},"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/dataset/top_keywords_per_page":{"post":{"tags":["dataset","top keywords per page"],"summary":"This API retrieves top N(default 5) keywords for a given page","operationId":"get_top_keywords_per_page_5_0_dataset_top_keywords_per_page_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketoTopKeywordsPerPageRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketoTopKeywordsPerPageResponse"}}}},"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/dataset/top_keywords":{"post":{"tags":["dataset","top keywords for a domain"],"summary":"This API retrieves top N(default 100) keywords for a given domain","operationId":"get_top_keywords_per_domain_5_0_dataset_top_keywords_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketoTopKeywordsPerDomainRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketoTopKeywordsPerDomainResponse"}}}},"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/dataset/paa_per_keyword":{"post":{"tags":["dataset","paa per keyword"],"summary":"This API retrieves top N(default 4) PAA questions for a given keyword","operationId":"get_paa_per_keyword_5_0_dataset_paa_per_keyword_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketoPaaRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketoPaaResponse"}}}},"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/dataset/ping":{"get":{"tags":["dataset","ping"],"summary":"This is simple ping api","operationId":"ping_latest5_dataset_ping_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/latest5/dataset/page_cache":{"post":{"tags":["dataset","page cache"],"summary":"This API retrieves page html cache from gcs for a given url","operationId":"get_page_cache_latest5_dataset_page_cache_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketoCacheRequest"}}},"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/dataset/page_crawl":{"post":{"tags":["dataset","page crawl"],"summary":"This API retrieves page html by crawling a given url","operationId":"crawl_page_content_latest5_dataset_page_crawl_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketoCacheRequest"}}},"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/dataset/top_pages":{"post":{"tags":["dataset","top pages"],"summary":"This API retrieves top N(default 1000) pages for a given base domain","operationId":"get_top_pages_latest5_dataset_top_pages_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketoTopPagesRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketoTopPagesResponse"}}}},"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/dataset/top_keywords_per_page":{"post":{"tags":["dataset","top keywords per page"],"summary":"This API retrieves top N(default 5) keywords for a given page","operationId":"get_top_keywords_per_page_latest5_dataset_top_keywords_per_page_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketoTopKeywordsPerPageRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketoTopKeywordsPerPageResponse"}}}},"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/dataset/top_keywords":{"post":{"tags":["dataset","top keywords for a domain"],"summary":"This API retrieves top N(default 100) keywords for a given domain","operationId":"get_top_keywords_per_domain_latest5_dataset_top_keywords_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketoTopKeywordsPerDomainRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketoTopKeywordsPerDomainResponse"}}}},"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/dataset/paa_per_keyword":{"post":{"tags":["dataset","paa per keyword"],"summary":"This API retrieves top N(default 4) PAA questions for a given keyword","operationId":"get_paa_per_keyword_latest5_dataset_paa_per_keyword_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketoPaaRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketoPaaResponse"}}}},"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/jobs":{"post":{"tags":["bulk_export","bulk_export"],"summary":"Create bulk export job(s)","description":"Create bulk export job(s) and store them in the database.\n\n- **pod**: Pod number for the job\n- **account_id**: Account ID or list of account IDs for the job(s)\n- **time_value**: Time value string or list of time values for the export\n- **time_cadence**: Time cadence (weekly, monthly, quarterly)\n- **query_type**: Type of query to run (keyword_join, keyword_only)\n- **user_id**: User ID creating the job\n- **path**: Google Cloud Storage path for the export\n- **destination**: Destination for export (default: \"gcs\")\n- **device_id**: Device ID filter (default: \"*\")\n- **group_id**: Group ID filter (default: \"*\")\n- **job_id**: Optional batch job ID (auto-generated if not provided)\n\nIf multiple account IDs are provided, separate jobs will be created for each account.\nIf multiple time values are provided, separate jobs will be created for each time value.\nThe combination of account IDs and time values will create multiple jobs as needed.","operationId":"create_bulk_export_job_5_0_jobs_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkExportJobCreateRequest"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkExportJobCreateResponse"}}}},"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/jobs/{job_id}":{"get":{"tags":["bulk_export","bulk_export"],"summary":"Get all bulk export jobs by batch job ID","description":"Get all bulk export jobs that share the same batch job ID.\n\n- **job_id**: Batch job ID (UUID) that groups multiple individual jobs","operationId":"get_bulk_export_jobs_by_batch_id_5_0_jobs__job_id__get","parameters":[{"required":true,"schema":{"type":"string","title":"Job Id"},"name":"job_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/BulkExportJobResponse"},"type":"array","title":"Response Get Bulk Export Jobs By Batch Id 5 0 Jobs Job 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/jobs/account/{account_id}":{"get":{"tags":["bulk_export","bulk_export"],"summary":"Get all bulk export jobs for an account","description":"Get all bulk export jobs for a specific account.\n\n- **account_id**: Account ID to get jobs for","operationId":"get_account_bulk_export_jobs_5_0_jobs_account__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/BulkExportJobResponse"},"type":"array","title":"Response Get Account Bulk Export Jobs 5 0 Jobs Account 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/jobs":{"post":{"tags":["bulk_export","bulk_export"],"summary":"Create bulk export job(s)","description":"Create bulk export job(s) and store them in the database.\n\n- **pod**: Pod number for the job\n- **account_id**: Account ID or list of account IDs for the job(s)\n- **time_value**: Time value string or list of time values for the export\n- **time_cadence**: Time cadence (weekly, monthly, quarterly)\n- **query_type**: Type of query to run (keyword_join, keyword_only)\n- **user_id**: User ID creating the job\n- **path**: Google Cloud Storage path for the export\n- **destination**: Destination for export (default: \"gcs\")\n- **device_id**: Device ID filter (default: \"*\")\n- **group_id**: Group ID filter (default: \"*\")\n- **job_id**: Optional batch job ID (auto-generated if not provided)\n\nIf multiple account IDs are provided, separate jobs will be created for each account.\nIf multiple time values are provided, separate jobs will be created for each time value.\nThe combination of account IDs and time values will create multiple jobs as needed.","operationId":"create_bulk_export_job_latest5_jobs_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkExportJobCreateRequest"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkExportJobCreateResponse"}}}},"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/jobs/{job_id}":{"get":{"tags":["bulk_export","bulk_export"],"summary":"Get all bulk export jobs by batch job ID","description":"Get all bulk export jobs that share the same batch job ID.\n\n- **job_id**: Batch job ID (UUID) that groups multiple individual jobs","operationId":"get_bulk_export_jobs_by_batch_id_latest5_jobs__job_id__get","parameters":[{"required":true,"schema":{"type":"string","title":"Job Id"},"name":"job_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/BulkExportJobResponse"},"type":"array","title":"Response Get Bulk Export Jobs By Batch Id Latest5 Jobs Job 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/jobs/account/{account_id}":{"get":{"tags":["bulk_export","bulk_export"],"summary":"Get all bulk export jobs for an account","description":"Get all bulk export jobs for a specific account.\n\n- **account_id**: Account ID to get jobs for","operationId":"get_account_bulk_export_jobs_latest5_jobs_account__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/BulkExportJobResponse"},"type":"array","title":"Response Get Account Bulk Export Jobs Latest5 Jobs Account 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/aicatalyst/accounts":{"get":{"tags":["ai_catalyst"],"summary":"This call returns the list of accounts where ai catalyst is enabled","operationId":"get_all_accounts_5_0_objects_aicatalyst_accounts_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/AICatalystsAccountOut"},"type":"array","title":"Response Get All Accounts 5 0 Objects Aicatalyst Accounts Get"}}}}},"security":[{"http_basic":[]},{"forwarded_http_basic":[]},{"session_cookie":[]},{"session_header":[]},{"api_token_header":[]},{"bearer_token":[]}]}},"/5.0/objects/aicatalyst/get_all_collectors":{"get":{"tags":["ai_catalyst"],"summary":"This call returns the list of all collectors supported by ai catalyst","operationId":"get_all_collectors_5_0_objects_aicatalyst_get_all_collectors_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AICatalystEnabledCollectors"}}}}}}},"/5.0/objects/aicatalyst/prompts/{account_id}":{"get":{"tags":["ai_catalyst"],"summary":"List of prompts set up in the account","operationId":"get_prompts_list_5_0_objects_aicatalyst_prompts__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":10000},"name":"count","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AICatalystPromptsListOut"}}}},"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/aicatalyst/prompt_info/{account_id}/{prompt_id}":{"get":{"tags":["ai_catalyst"],"summary":"Detailed info about one prompt","operationId":"get_prompts_list_5_0_objects_aicatalyst_prompt_info__account_id___prompt_id__get","parameters":[{"required":true,"schema":{"type":"integer","title":"Prompt Id"},"name":"prompt_id","in":"path"},{"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/AICatalystsPromptInfo"}}}},"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/aicatalyst/promptgroups/{account_id}":{"get":{"tags":["ai_catalyst"],"summary":"List of prompt groups set up in the account","operationId":"get_prompts_list_5_0_objects_aicatalyst_promptgroups__account_id__get","parameters":[{"required":true,"schema":{"type":"integer","title":"Account Id"},"name":"account_id","in":"path"},{"required":false,"schema":{"type":"integer","title":"Count","default":10000},"name":"count","in":"query"},{"required":false,"schema":{"type":"integer","title":"Offset","default":0},"name":"offset","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AICatalystsPromptGroupOut"}}}},"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/aicatalyst/promptgroups/prompts/{account_id}/{prompt_group_id}":{"get":{"tags":["ai_catalyst"],"summary":"List of prompts tied to the specified prompt group ","operationId":"get_prompt_group_and_prompt_name_5_0_objects_aicatalyst_promptgroups_prompts__account_id___prompt_group_id__get","parameters":[{"required":true,"schema":{"type":"integer","title":"Account Id"},"name":"account_id","in":"path"},{"required":true,"schema":{"type":"integer","title":"Prompt Group Id"},"name":"prompt_group_id","in":"path"},{"required":false,"schema":{"type":"integer","title":"Offset","default":0},"name":"offset","in":"query"},{"required":false,"schema":{"type":"integer","title":"Count","default":10000},"name":"count","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AICatalystsPromptGroupPromptsOut"}}}},"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/aicatalyst/aiengines/{account_id}":{"get":{"tags":["ai_catalyst"],"summary":"View all enabled AI engines for the account","operationId":"get_prompt_group_and_prompt_name_5_0_objects_aicatalyst_aiengines__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":10000},"name":"count","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AICatalystEnabledEngines"}}}},"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/aicatalyst/enabled_collectors/{account_id}":{"get":{"tags":["ai_catalyst"],"summary":"View all enabled collectors for the account","operationId":"get_enabled_collectors_5_0_objects_aicatalyst_enabled_collectors__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":10000},"name":"count","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AICatalystEnabledCollectorsForAccount"}}}},"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/aicatalyst/list_brand_categories":{"post":{"tags":["ai_catalyst"],"summary":"Get list of brand categories with filtering and sorting support","operationId":"list_brand_category_5_0_objects_aicatalyst_list_brand_categories_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AICatalystBrandCategoryRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AICatalystPresenceBrandCategory"}}}},"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/aicatalyst/query":{"post":{"tags":["ai_catalyst"],"summary":"Get the share of citations or mentions data (legacy format)","operationId":"share_of_data_5_0_objects_aicatalyst_query_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AICatalystsShareOfDataRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AICatalystsShareOfDataResponse"}}}},"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/aicatalyst/v2/query":{"post":{"tags":["ai_catalyst"],"summary":"Get the share of citations, mentions, or prompts data with dimensions and measures","operationId":"share_of_data_v2_5_0_objects_aicatalyst_v2_query_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AICatalystsShareOfDataRequestV2"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AICatalystsShareOfDataResponseV2"}}}},"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/aicatalyst/personas/{account_id}":{"get":{"tags":["ai_catalyst"],"summary":"View all personas for the account","operationId":"get_personas_5_0_objects_aicatalyst_personas__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":10000},"name":"count","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AICatalystPersonas"}}}},"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/aicatalyst/accounts":{"get":{"tags":["ai_catalyst"],"summary":"This call returns the list of accounts where ai catalyst is enabled","operationId":"get_all_accounts_latest5_objects_aicatalyst_accounts_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/AICatalystsAccountOut"},"type":"array","title":"Response Get All Accounts Latest5 Objects Aicatalyst Accounts Get"}}}}},"security":[{"http_basic":[]},{"forwarded_http_basic":[]},{"session_cookie":[]},{"session_header":[]},{"api_token_header":[]},{"bearer_token":[]}]}},"/latest5/objects/aicatalyst/get_all_collectors":{"get":{"tags":["ai_catalyst"],"summary":"This call returns the list of all collectors supported by ai catalyst","operationId":"get_all_collectors_latest5_objects_aicatalyst_get_all_collectors_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AICatalystEnabledCollectors"}}}}}}},"/latest5/objects/aicatalyst/prompts/{account_id}":{"get":{"tags":["ai_catalyst"],"summary":"List of prompts set up in the account","operationId":"get_prompts_list_latest5_objects_aicatalyst_prompts__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":10000},"name":"count","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AICatalystPromptsListOut"}}}},"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/aicatalyst/prompt_info/{account_id}/{prompt_id}":{"get":{"tags":["ai_catalyst"],"summary":"Detailed info about one prompt","operationId":"get_prompts_list_latest5_objects_aicatalyst_prompt_info__account_id___prompt_id__get","parameters":[{"required":true,"schema":{"type":"integer","title":"Prompt Id"},"name":"prompt_id","in":"path"},{"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/AICatalystsPromptInfo"}}}},"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/aicatalyst/promptgroups/{account_id}":{"get":{"tags":["ai_catalyst"],"summary":"List of prompt groups set up in the account","operationId":"get_prompts_list_latest5_objects_aicatalyst_promptgroups__account_id__get","parameters":[{"required":true,"schema":{"type":"integer","title":"Account Id"},"name":"account_id","in":"path"},{"required":false,"schema":{"type":"integer","title":"Count","default":10000},"name":"count","in":"query"},{"required":false,"schema":{"type":"integer","title":"Offset","default":0},"name":"offset","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AICatalystsPromptGroupOut"}}}},"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/aicatalyst/promptgroups/prompts/{account_id}/{prompt_group_id}":{"get":{"tags":["ai_catalyst"],"summary":"List of prompts tied to the specified prompt group ","operationId":"get_prompt_group_and_prompt_name_latest5_objects_aicatalyst_promptgroups_prompts__account_id___prompt_group_id__get","parameters":[{"required":true,"schema":{"type":"integer","title":"Account Id"},"name":"account_id","in":"path"},{"required":true,"schema":{"type":"integer","title":"Prompt Group Id"},"name":"prompt_group_id","in":"path"},{"required":false,"schema":{"type":"integer","title":"Offset","default":0},"name":"offset","in":"query"},{"required":false,"schema":{"type":"integer","title":"Count","default":10000},"name":"count","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AICatalystsPromptGroupPromptsOut"}}}},"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/aicatalyst/aiengines/{account_id}":{"get":{"tags":["ai_catalyst"],"summary":"View all enabled AI engines for the account","operationId":"get_prompt_group_and_prompt_name_latest5_objects_aicatalyst_aiengines__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":10000},"name":"count","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AICatalystEnabledEngines"}}}},"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/aicatalyst/enabled_collectors/{account_id}":{"get":{"tags":["ai_catalyst"],"summary":"View all enabled collectors for the account","operationId":"get_enabled_collectors_latest5_objects_aicatalyst_enabled_collectors__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":10000},"name":"count","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AICatalystEnabledCollectorsForAccount"}}}},"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/aicatalyst/list_brand_categories":{"post":{"tags":["ai_catalyst"],"summary":"Get list of brand categories with filtering and sorting support","operationId":"list_brand_category_latest5_objects_aicatalyst_list_brand_categories_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AICatalystBrandCategoryRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AICatalystPresenceBrandCategory"}}}},"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/aicatalyst/query":{"post":{"tags":["ai_catalyst"],"summary":"Get the share of citations or mentions data (legacy format)","operationId":"share_of_data_latest5_objects_aicatalyst_query_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AICatalystsShareOfDataRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AICatalystsShareOfDataResponse"}}}},"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/aicatalyst/v2/query":{"post":{"tags":["ai_catalyst"],"summary":"Get the share of citations, mentions, or prompts data with dimensions and measures","operationId":"share_of_data_v2_latest5_objects_aicatalyst_v2_query_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AICatalystsShareOfDataRequestV2"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AICatalystsShareOfDataResponseV2"}}}},"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/aicatalyst/personas/{account_id}":{"get":{"tags":["ai_catalyst"],"summary":"View all personas for the account","operationId":"get_personas_latest5_objects_aicatalyst_personas__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":10000},"name":"count","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AICatalystPersonas"}}}},"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/productgrid/info":{"post":{"tags":["product_grid","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","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","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","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","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","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","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","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","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","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","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","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","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","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","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","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","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","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","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","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":[]}]}},"/5.0/objects/users/create":{"post":{"tags":["users"],"summary":"Create a new user","description":"Create a new user.\nMandatory fields: org_id, account_id, login","operationId":"create_user_route_5_0_objects_users_create_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUserRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserCreateResponse"}}}},"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/users/update":{"post":{"tags":["users"],"summary":"Update user details","description":"Update existing user.\nMandatory field: login","operationId":"update_user_5_0_objects_users_update_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserUpdateResponse"}}}},"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/users/{login}":{"delete":{"tags":["users"],"summary":"Delete a user","description":"Delete existing user.\nMandatory field: login","operationId":"delete_user_5_0_objects_users__login__delete","parameters":[{"required":true,"schema":{"type":"string","format":"email","title":"Login"},"name":"login","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserDeleteResponse"}}}},"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/users/grant_account_access":{"post":{"tags":["users"],"summary":"Grant account access to user","description":"Grant access to multiple accounts for a user.\nCreates or updates user_accounts rows for each account_id provided.","operationId":"grant_user_account_access_5_0_objects_users_grant_account_access_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserAccountAccessRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserAccountAccessResponse"}}}},"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/users/revoke_account_access":{"post":{"tags":["users"],"summary":"Revoke account access from user","description":"Grant access to multiple accounts for a user.\nCreates or updates user_accounts rows for each account_id provided.","operationId":"revoke_user_account_access_5_0_objects_users_revoke_account_access_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserAccountAccessRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserAccountAccessResponse"}}}},"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/users/bulk-create":{"post":{"tags":["users"],"summary":"Bulk create users","operationId":"bulk_create_users_5_0_objects_users_bulk_create_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkCreateUserRequest"}}},"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/users/bulk-update":{"post":{"tags":["users"],"summary":"Bulk update users","operationId":"bulk_update_users_5_0_objects_users_bulk_update_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkUpdateUserRequest"}}},"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/users/bulk-delete":{"post":{"tags":["users"],"summary":"Bulk delete users","operationId":"bulk_delete_users_5_0_objects_users_bulk_delete_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkDeleteUserRequest"}}},"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/users/create":{"post":{"tags":["users"],"summary":"Create a new user","description":"Create a new user.\nMandatory fields: org_id, account_id, login","operationId":"create_user_route_latest5_objects_users_create_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUserRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserCreateResponse"}}}},"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/users/update":{"post":{"tags":["users"],"summary":"Update user details","description":"Update existing user.\nMandatory field: login","operationId":"update_user_latest5_objects_users_update_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserUpdateResponse"}}}},"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/users/{login}":{"delete":{"tags":["users"],"summary":"Delete a user","description":"Delete existing user.\nMandatory field: login","operationId":"delete_user_latest5_objects_users__login__delete","parameters":[{"required":true,"schema":{"type":"string","format":"email","title":"Login"},"name":"login","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserDeleteResponse"}}}},"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/users/grant_account_access":{"post":{"tags":["users"],"summary":"Grant account access to user","description":"Grant access to multiple accounts for a user.\nCreates or updates user_accounts rows for each account_id provided.","operationId":"grant_user_account_access_latest5_objects_users_grant_account_access_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserAccountAccessRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserAccountAccessResponse"}}}},"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/users/revoke_account_access":{"post":{"tags":["users"],"summary":"Revoke account access from user","description":"Grant access to multiple accounts for a user.\nCreates or updates user_accounts rows for each account_id provided.","operationId":"revoke_user_account_access_latest5_objects_users_revoke_account_access_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserAccountAccessRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserAccountAccessResponse"}}}},"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/users/bulk-create":{"post":{"tags":["users"],"summary":"Bulk create users","operationId":"bulk_create_users_latest5_objects_users_bulk_create_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkCreateUserRequest"}}},"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/users/bulk-update":{"post":{"tags":["users"],"summary":"Bulk update users","operationId":"bulk_update_users_latest5_objects_users_bulk_update_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkUpdateUserRequest"}}},"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/users/bulk-delete":{"post":{"tags":["users"],"summary":"Bulk delete users","operationId":"bulk_delete_users_latest5_objects_users_bulk_delete_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkDeleteUserRequest"}}},"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/pages/keywords/primary_secondary":{"get":{"summary":"Get Primary/Secondary Keywords","operationId":"keywords_5_0_pages_keywords_primary_secondary_get","parameters":[{"required":true,"schema":{"type":"integer","title":"Account Id"},"name":"account_id","in":"query"},{"required":true,"schema":{"type":"string","title":"Url"},"name":"url","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PSKeywords"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"http_basic":[]},{"forwarded_http_basic":[]},{"session_cookie":[]},{"session_header":[]}]}},"/5.0/pages/details":{"get":{"summary":"Get Page Details","operationId":"pages_5_0_pages_details_get","parameters":[{"required":true,"schema":{"type":"integer","title":"Account Id"},"name":"account_id","in":"query"},{"required":true,"schema":{"type":"string","title":"Url"},"name":"url","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageDetails"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"http_basic":[]},{"forwarded_http_basic":[]},{"session_cookie":[]},{"session_header":[]}]},"post":{"summary":"Update Page Details","operationId":"pages_5_0_pages_details_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageDetailsInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"boolean","title":"Response Pages 5 0 Pages Details Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"http_basic":[]},{"forwarded_http_basic":[]},{"session_cookie":[]},{"session_header":[]}]}},"/latest5/pages/keywords/primary_secondary":{"get":{"summary":"Get Primary/Secondary Keywords","operationId":"keywords_latest5_pages_keywords_primary_secondary_get","parameters":[{"required":true,"schema":{"type":"integer","title":"Account Id"},"name":"account_id","in":"query"},{"required":true,"schema":{"type":"string","title":"Url"},"name":"url","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PSKeywords"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"http_basic":[]},{"forwarded_http_basic":[]},{"session_cookie":[]},{"session_header":[]}]}},"/latest5/pages/details":{"get":{"summary":"Get Page Details","operationId":"pages_latest5_pages_details_get","parameters":[{"required":true,"schema":{"type":"integer","title":"Account Id"},"name":"account_id","in":"query"},{"required":true,"schema":{"type":"string","title":"Url"},"name":"url","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageDetails"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"http_basic":[]},{"forwarded_http_basic":[]},{"session_cookie":[]},{"session_header":[]}]},"post":{"summary":"Update Page Details","operationId":"pages_latest5_pages_details_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageDetailsInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"boolean","title":"Response Pages Latest5 Pages Details Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"http_basic":[]},{"forwarded_http_basic":[]},{"session_cookie":[]},{"session_header":[]}]}}},"components":{"schemas":{"AIBDatasetType":{"type":"string","enum":["mentions","citations","prompts"],"title":"AIBDatasetType","description":"Dataset type for AI Brand Presence data requests"},"AIBUser":{"properties":{"user_id":{"type":"integer","title":"User Id"},"first_name":{"type":"string","title":"First Name"},"last_name":{"type":"string","title":"Last Name"},"email":{"type":"string","title":"Email"}},"type":"object","required":["user_id","first_name","last_name","email"],"title":"AIBUser"},"AICatalystBrandCategoryRequest":{"properties":{"account_id":{"type":"integer","title":"Account Id"},"domain":{"type":"string","title":"Domain"},"monitored":{"type":"boolean","title":"Monitored"},"filters":{"items":{"items":{"type":"string"},"type":"array"},"type":"array","title":"Filters"},"sort":{"items":{"items":{"type":"string"},"type":"array"},"type":"array","title":"Sort","default":[["brand_domain","asc"]]},"count":{"type":"integer","title":"Count","default":10000},"offset":{"type":"integer","title":"Offset","default":0}},"type":"object","required":["account_id","domain"],"title":"AICatalystBrandCategoryRequest"},"AICatalystEnabledCollectors":{"properties":{"success":{"type":"boolean","title":"Success"},"message":{"type":"string","title":"Message"},"collectors":{"items":{"$ref":"#/components/schemas/CollectorInfo"},"type":"array","title":"Collectors"}},"type":"object","required":["success","message","collectors"],"title":"AICatalystEnabledCollectors"},"AICatalystEnabledCollectorsForAccount":{"properties":{"success":{"type":"boolean","title":"Success"},"message":{"type":"string","title":"Message"},"account_id":{"type":"integer","title":"Account Id"},"collectors":{"items":{"$ref":"#/components/schemas/CollectorInfo"},"type":"array","title":"Collectors"}},"type":"object","required":["success","message","account_id","collectors"],"title":"AICatalystEnabledCollectorsForAccount"},"AICatalystEnabledEngines":{"properties":{"success":{"type":"boolean","title":"Success"},"message":{"type":"string","title":"Message"},"account_id":{"type":"integer","title":"Account Id"},"engines":{"items":{"type":"string"},"type":"array","title":"Engines"}},"type":"object","required":["success","message","account_id","engines"],"title":"AICatalystEnabledEngines"},"AICatalystPersona":{"properties":{"persona_id":{"type":"integer","title":"Persona Id"},"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"},"updated_by":{"$ref":"#/components/schemas/AIBUser"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"is_default":{"type":"boolean","title":"Is Default"},"date_updated":{"type":"string","format":"date-time","title":"Date Updated"}},"type":"object","required":["persona_id","name","description"],"title":"AICatalystPersona"},"AICatalystPersonas":{"properties":{"success":{"type":"boolean","title":"Success"},"message":{"type":"string","title":"Message"},"personas":{"items":{"$ref":"#/components/schemas/AICatalystPersona"},"type":"array","title":"Personas"}},"type":"object","required":["success","message","personas"],"title":"AICatalystPersonas"},"AICatalystPresenceBrandCategory":{"properties":{"success":{"type":"boolean","title":"Success"},"message":{"type":"string","title":"Message"},"data":{"items":{"type":"object"},"type":"array","title":"Data"}},"type":"object","required":["success","message"],"title":"AICatalystPresenceBrandCategory"},"AICatalystPromptsList":{"properties":{"prompt_id":{"type":"integer","title":"Prompt Id"},"prompt_name":{"type":"string","title":"Prompt Name"},"collector_ids":{"items":{"type":"integer"},"type":"array","title":"Collector Ids"},"intent":{"items":{"type":"string"},"type":"array","title":"Intent"}},"type":"object","required":["prompt_id","prompt_name","collector_ids","intent"],"title":"AICatalystPromptsList"},"AICatalystPromptsListOut":{"properties":{"account_id":{"type":"integer","title":"Account Id"},"success":{"type":"boolean","title":"Success"},"message":{"type":"string","title":"Message"},"prompt_groups":{"items":{"$ref":"#/components/schemas/AICatalystPromptsList"},"type":"array","title":"Prompt Groups"}},"type":"object","required":["account_id","success","message","prompt_groups"],"title":"AICatalystPromptsListOut"},"AICatalystsAccountOut":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"}},"type":"object","required":["id","name"],"title":"AICatalystsAccountOut"},"AICatalystsPromptGroup":{"properties":{"prompt_group_id":{"type":"integer","title":"Prompt Group Id"},"prompt_group":{"type":"string","title":"Prompt Group"},"number_of_prompts":{"type":"integer","title":"Number Of Prompts"},"created_on":{"type":"string","format":"date-time","title":"Created On"},"last_updated_on":{"type":"string","format":"date-time","title":"Last Updated On"},"collector_ids":{"items":{"type":"integer"},"type":"array","title":"Collector Ids","default":[]},"personality_ids":{"items":{"type":"integer"},"type":"array","title":"Personality Ids","default":[]}},"type":"object","required":["prompt_group_id","prompt_group","number_of_prompts","created_on","last_updated_on"],"title":"AICatalystsPromptGroup"},"AICatalystsPromptGroupOut":{"properties":{"account_id":{"type":"integer","title":"Account Id"},"success":{"type":"boolean","title":"Success"},"message":{"type":"string","title":"Message"},"prompt_groups":{"items":{"$ref":"#/components/schemas/AICatalystsPromptGroup"},"type":"array","title":"Prompt Groups"}},"type":"object","required":["account_id","success","message","prompt_groups"],"title":"AICatalystsPromptGroupOut"},"AICatalystsPromptGroupPrompt":{"properties":{"prompt_id":{"type":"integer","title":"Prompt Id"},"prompt":{"type":"string","title":"Prompt"}},"type":"object","required":["prompt_id","prompt"],"title":"AICatalystsPromptGroupPrompt"},"AICatalystsPromptGroupPrompts":{"properties":{"prompt_group_id":{"type":"integer","title":"Prompt Group Id"},"prompt_group":{"type":"string","title":"Prompt Group"},"prompts":{"items":{"$ref":"#/components/schemas/AICatalystsPromptGroupPrompt"},"type":"array","title":"Prompts"}},"type":"object","required":["prompt_group_id","prompt_group","prompts"],"title":"AICatalystsPromptGroupPrompts"},"AICatalystsPromptGroupPromptsOut":{"properties":{"account_id":{"type":"integer","title":"Account Id"},"success":{"type":"boolean","title":"Success"},"message":{"type":"string","title":"Message"},"prompt_groups":{"items":{"$ref":"#/components/schemas/AICatalystsPromptGroupPrompts"},"type":"array","title":"Prompt Groups"}},"type":"object","required":["account_id","success","message","prompt_groups"],"title":"AICatalystsPromptGroupPromptsOut"},"AICatalystsPromptInfo":{"properties":{"prompt_id":{"type":"integer","title":"Prompt Id"},"prompt_name":{"type":"string","title":"Prompt Name"},"intents":{"type":"string","title":"Intents"},"prompt_groups":{"type":"string","title":"Prompt Groups"},"collector_ids":{"items":{"type":"integer"},"type":"array","title":"Collector Ids"},"country":{"type":"string","title":"Country"},"created_on":{"type":"string","format":"date-time","title":"Created On"},"last_updated_on":{"type":"string","format":"date-time","title":"Last Updated On"}},"type":"object","required":["prompt_id","prompt_name","created_on","last_updated_on"],"title":"AICatalystsPromptInfo"},"AICatalystsShareOfDataRequest":{"properties":{"dataset":{"allOf":[{"$ref":"#/components/schemas/AIBDatasetType"}],"description":"Dataset type: 'mentions' or 'citations' or 'report'"},"account_id":{"type":"integer","title":"Account Id"},"time_range":{"items":{"type":"integer"},"type":"array","title":"Time Range"},"time_range_type":{"type":"string","title":"Time Range Type"},"collector_ids":{"items":{"type":"integer"},"type":"array","title":"Collector Ids","default":[]},"personality_id_list":{"items":{"type":"integer"},"type":"array","title":"Personality Id List","default":[]},"topic_id_list":{"items":{"type":"integer"},"type":"array","title":"Topic Id List","default":[]},"use_cache":{"type":"boolean","title":"Use Cache","default":false},"offset":{"type":"integer","title":"Offset","default":0},"count":{"type":"integer","title":"Count","default":10000},"sort":{"items":{},"type":"array","title":"Sort","default":[]},"filters":{"items":{},"type":"array","title":"Filters","default":[]},"brand_category_id_list":{"items":{"type":"integer"},"type":"array","title":"Brand Category Id List","default":[]},"prompt_type":{"type":"integer","title":"Prompt Type"},"by_domain":{"type":"boolean","title":"By Domain","default":true},"output_type":{"allOf":[{"$ref":"#/components/schemas/OutputType"}],"default":"parsed"}},"type":"object","required":["dataset","account_id","time_range","time_range_type"],"title":"AICatalystsShareOfDataRequest"},"AICatalystsShareOfDataRequestV2":{"properties":{"dataset":{"$ref":"#/components/schemas/AIBDatasetType"},"account_id":{"type":"integer","title":"Account Id"},"dimensions":{"items":{"type":"string"},"type":"array","title":"Dimensions"},"dimensionOptions":{"type":"object","title":"Dimensionoptions"},"measures":{"items":{"type":"string"},"type":"array","title":"Measures"},"additional_measures":{"items":{"type":"string"},"type":"array","title":"Additional Measures"},"filters":{"items":{"items":{"type":"string"},"type":"array"},"type":"array","title":"Filters"},"offset":{"type":"integer","title":"Offset","default":0},"count":{"type":"integer","title":"Count","default":10000},"sort":{"items":{},"type":"array","title":"Sort","default":[]},"output_type":{"allOf":[{"$ref":"#/components/schemas/OutputType"}],"default":"parsed"},"use_cache":{"type":"boolean","title":"Use Cache","default":false}},"type":"object","required":["dataset","account_id"],"title":"AICatalystsShareOfDataRequestV2","description":"New V2 request format with dimensions, measures, and filter triplets.\nSupports datasets: mentions, citations, prompts"},"AICatalystsShareOfDataResponse":{"properties":{"success":{"type":"boolean","title":"Success"},"message":{"type":"string","title":"Message"},"dataset":{"$ref":"#/components/schemas/AIBDatasetType"},"data":{"title":"Data"}},"type":"object","required":["success","message","dataset"],"title":"AICatalystsShareOfDataResponse"},"AICatalystsShareOfDataResponseV2":{"properties":{"success":{"type":"boolean","title":"Success"},"message":{"type":"string","title":"Message"},"dataset":{"$ref":"#/components/schemas/AIBDatasetType"},"metadata":{"$ref":"#/components/schemas/ResponseMetadata"},"data":{"title":"Data"}},"type":"object","required":["success","message","dataset"],"title":"AICatalystsShareOfDataResponseV2","description":"V2 response format with metadata"},"AccountIdIn":{"properties":{"excluded_keyword_group_filter":{"items":{"type":"string"},"type":"array","title":"Excluded Keyword Group Filter"}},"type":"object","title":"AccountIdIn"},"AccountIdOut":{"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":"boolean","title":"Ga Integration Setup"},"GSC_integration_setup":{"type":"boolean","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":"boolean","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"},"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"],"title":"AccountIdOut"},"AccountInputModel":{"properties":{"account_id":{"type":"integer","title":"Account Id"}},"type":"object","required":["account_id"],"title":"AccountInputModel","description":"Account input model."},"AccountOut":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"created_on":{"type":"string","format":"date-time","title":"Created On"}},"type":"object","required":["id","name","created_on"],"title":"AccountOut"},"AddRemoveKeywordsToGroupRequest":{"properties":{"keywords":{"items":{"type":"string"},"type":"array","title":"Keywords"},"group_id":{"type":"integer","title":"Group Id"},"action":{"type":"string","title":"Action"}},"type":"object","required":["keywords","group_id","action"],"title":"AddRemoveKeywordsToGroupRequest"},"AutoPilotCacheClearIn":{"properties":{"customerId":{"type":"string","title":"Customerid"},"url":{"type":"string","title":"Url"},"urlType":{"type":"string","title":"Urltype"}},"type":"object","required":["customerId","url"],"title":"AutoPilotCacheClearIn"},"AutoPilotCacheInvalidateIn":{"properties":{"customerId":{"type":"string","title":"Customerid"},"paths":{"items":{"type":"string"},"type":"array","title":"Paths"}},"type":"object","required":["customerId"],"title":"AutoPilotCacheInvalidateIn"},"AutoPilotFoundationsCertificate":{"properties":{"certificate":{"type":"string","title":"Certificate"},"ceritificateKey":{"type":"string","title":"Ceritificatekey"}},"type":"object","required":["certificate","ceritificateKey"],"title":"AutoPilotFoundationsCertificate"},"BELocalResponse":{"properties":{"status":{"type":"boolean","title":"Status"},"data":{"items":{},"type":"array","title":"Data"},"message":{"type":"string","title":"Message"}},"type":"object","required":["status"],"title":"BELocalResponse"},"BQLQueryOut":{"properties":{"count":{"type":"integer","title":"Count"},"offset":{"type":"integer","title":"Offset"},"total":{"type":"integer","title":"Total"},"values":{"items":{"type":"object"},"type":"array","title":"Values"}},"type":"object","required":["count","offset","values"],"title":"BQLQueryOut"},"BacklinksOut":{"properties":{"url":{"type":"string","title":"Url"},"page_authority":{"type":"string","title":"Page Authority"}},"type":"object","required":["url","page_authority"],"title":"BacklinksOut"},"BrandFiltersOut":{"properties":{"bql_filters":{"type":"string","title":"Bql Filters"},"keywords":{"items":{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"string","format":"date-time"}]},"type":"object"},"type":"array","title":"Keywords"}},"type":"object","required":["bql_filters","keywords"],"title":"BrandFiltersOut"},"BulkCreateUserRequest":{"properties":{"users":{"items":{"$ref":"#/components/schemas/CreateUserRequest"},"type":"array","title":"Users"}},"type":"object","required":["users"],"title":"BulkCreateUserRequest"},"BulkDeleteUserRequest":{"properties":{"logins":{"items":{"type":"string","format":"email"},"type":"array","title":"Logins"}},"type":"object","required":["logins"],"title":"BulkDeleteUserRequest"},"BulkExportJobCreateRequest":{"properties":{"pod":{"type":"integer","title":"Pod"},"account_id":{"anyOf":[{"type":"integer"},{"items":{"type":"integer"},"type":"array"}],"title":"Account Id"},"time_value":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"}],"title":"Time Value"},"time_cadence":{"type":"string","title":"Time Cadence"},"query_type":{"type":"string","title":"Query Type"},"user_id":{"type":"integer","title":"User Id"},"path":{"type":"string","title":"Path"},"destination":{"type":"string","title":"Destination","default":"gcs"},"job_id":{"type":"string","title":"Job Id"},"device_id":{"type":"string","title":"Device Id","default":"*"},"group_id":{"type":"string","title":"Group Id","default":"*"}},"type":"object","required":["pod","account_id","time_value","time_cadence","query_type","user_id","path"],"title":"BulkExportJobCreateRequest"},"BulkExportJobCreateResponse":{"properties":{"jobs":{"items":{"$ref":"#/components/schemas/BulkExportJobResponse"},"type":"array","title":"Jobs"},"total_jobs_created":{"type":"integer","title":"Total Jobs Created"},"message":{"type":"string","title":"Message"}},"type":"object","required":["jobs","total_jobs_created","message"],"title":"BulkExportJobCreateResponse","description":"Response model for bulk job creation (handles multiple jobs)"},"BulkExportJobResponse":{"properties":{"id":{"type":"string","title":"Id"},"job_id":{"type":"string","title":"Job Id"},"pod":{"type":"integer","title":"Pod"},"account_id":{"type":"integer","title":"Account Id"},"time_value":{"type":"string","title":"Time Value"},"time_cadence":{"type":"string","title":"Time Cadence"},"query_type":{"type":"string","title":"Query Type"},"user_id":{"type":"integer","title":"User Id"},"status":{"type":"integer","title":"Status"},"job_create_at":{"type":"string","format":"date-time","title":"Job Create At"},"job_start_at":{"type":"string","format":"date-time","title":"Job Start At"},"job_finish_at":{"type":"string","format":"date-time","title":"Job Finish At"},"job_exception":{"type":"string","title":"Job Exception"},"path":{"type":"string","title":"Path"},"retry_count":{"type":"integer","title":"Retry Count","default":0},"destination":{"type":"string","title":"Destination","default":"gcs"},"device_id":{"type":"string","title":"Device Id","default":"*"},"group_id":{"type":"string","title":"Group Id","default":"*"}},"type":"object","required":["id","job_id","pod","account_id","time_value","time_cadence","query_type","user_id","status","job_create_at"],"title":"BulkExportJobResponse"},"BulkUpdateUserRequest":{"properties":{"users":{"items":{"$ref":"#/components/schemas/UpdateUserRequest"},"type":"array","title":"Users"}},"type":"object","required":["users"],"title":"BulkUpdateUserRequest"},"CSVKeywordGroupMetricsExportRequest":{"properties":{"body":{"$ref":"#/components/schemas/KeywordGroupMetricsInputModel"},"columns":{"items":{"$ref":"#/components/schemas/ColumnConfig"},"type":"array","title":"Columns"}},"type":"object","required":["body","columns"],"title":"CSVKeywordGroupMetricsExportRequest"},"CSVKeywordMetricsExportRequest":{"properties":{"body":{"$ref":"#/components/schemas/KeywordsMetricsInputModel"},"columns":{"items":{"$ref":"#/components/schemas/ColumnConfig"},"type":"array","title":"Columns"}},"type":"object","required":["body","columns"],"title":"CSVKeywordMetricsExportRequest"},"CollectorInfo":{"properties":{"collector_id":{"type":"integer","title":"Collector Id"},"engine_id":{"type":"integer","title":"Engine Id"},"locale":{"type":"string","title":"Locale"},"location":{"type":"string","title":"Location"},"language":{"type":"string","title":"Language"},"engine_name":{"type":"string","title":"Engine Name"},"status":{"type":"integer","title":"Status"}},"type":"object","required":["collector_id","engine_id","locale","location","language","engine_name","status"],"title":"CollectorInfo"},"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"},"CompetitorOut":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"}},"type":"object","required":["id","name"],"title":"CompetitorOut"},"Content":{"properties":{"word_count":{"type":"integer","title":"Word Count"},"headings":{"$ref":"#/components/schemas/Headings"}},"type":"object","required":["word_count","headings"],"title":"Content"},"ContentInput":{"properties":{"account_id":{"type":"integer","title":"Account Id"},"se_group_id":{"type":"integer","title":"Se Group Id"},"url":{"type":"string","title":"Url"}},"type":"object","required":["account_id","se_group_id","url"],"title":"ContentInput"},"CreateUserRequest":{"properties":{"org_id":{"type":"integer","title":"Org Id","description":"Organization ID"},"account_id":{"type":"integer","title":"Account Id","description":"Account ID"},"login":{"type":"string","format":"email","title":"Login","description":"User login/email"},"user_type":{"type":"integer","title":"User Type","description":"User type","default":1},"role":{"type":"integer","title":"Role","description":"User role","default":1},"additional_user_account_id_list":{"items":{"type":"integer"},"type":"array","title":"Additional User Account Id List","description":"Additional account IDs for the user"},"first_name":{"type":"string","title":"First Name","description":"User's first name"},"last_name":{"type":"string","title":"Last Name","description":"User's last name"}},"type":"object","required":["org_id","account_id","login"],"title":"CreateUserRequest"},"DateRange":{"properties":{"start_date":{"type":"string","title":"Start Date"},"end_date":{"type":"string","title":"End Date"}},"type":"object","required":["start_date","end_date"],"title":"DateRange"},"DimensionOptionsMetadata":{"properties":{"time_type":{"type":"string","title":"Time Type"},"time_value":{"type":"integer","title":"Time Value"},"collector_ids":{"items":{"type":"integer"},"type":"array","title":"Collector Ids"},"brand_category_id_list":{"items":{"type":"integer"},"type":"array","title":"Brand Category Id List"},"personality_id_list":{"items":{"type":"integer"},"type":"array","title":"Personality Id List"},"topic_id_list":{"items":{"type":"integer"},"type":"array","title":"Topic Id List"},"brand_domain":{"type":"string","title":"Brand Domain"},"domain":{"type":"string","title":"Domain"},"by_domain":{"type":"boolean","title":"By Domain"}},"type":"object","title":"DimensionOptionsMetadata","description":"Metadata for dimension options applied to the query"},"DomainComparisonInput":{"properties":{"account_id":{"type":"integer","title":"Account Id"},"base_domain":{"type":"string","title":"Base Domain"},"compare_domain":{"type":"string","title":"Compare Domain"},"se_group_id":{"type":"string","title":"Se Group Id"}},"type":"object","required":["account_id","base_domain","compare_domain","se_group_id"],"title":"DomainComparisonInput"},"DomainOut":{"properties":{"id":{"type":"integer","title":"Id"},"account_id":{"type":"integer","title":"Account Id"},"name":{"type":"string","title":"Name"}},"type":"object","required":["id","account_id","name"],"title":"DomainOut"},"FeatureName":{"type":"string","enum":["platformapi","chromeextension"],"title":"FeatureName","description":"Used to verify feature names for /query feature_name input"},"GeogorianTimeTimeStringType":{"type":"string","enum":["daily","weekly","monthly","quarterly","yearly"],"title":"GeogorianTimeTimeStringType","description":"An enumeration."},"GetAccountsData":{"properties":{"account_id":{"type":"integer","title":"Account Id"},"external_id":{"type":"string","title":"External Id"}},"type":"object","required":["account_id"],"title":"GetAccountsData"},"GetAllAttributes":{"properties":{"language_code":{"type":"string","title":"Language Code","default":"en"},"region_code":{"type":"string","title":"Region Code","default":"US"},"showAll":{"type":"boolean","title":"Showall","default":true},"do_live_fallback_call":{"type":"boolean","title":"Do Live Fallback Call","default":true}},"type":"object","title":"GetAllAttributes"},"GetLocationAttributes":{"properties":{"location_name":{"type":"string","title":"Location Name"}},"type":"object","required":["location_name"],"title":"GetLocationAttributes"},"GetWebVitalsData":{"properties":{"range":{"$ref":"#/components/schemas/DateRange"},"domain":{"type":"string","title":"Domain"}},"type":"object","required":["domain"],"title":"GetWebVitalsData"},"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."},"GridTypesTrendChartTimeItem":{"properties":{"time":{"type":"integer","title":"Time"},"keywords":{"type":"integer","title":"Keywords"}},"type":"object","required":["time","keywords"],"title":"GridTypesTrendChartTimeItem","description":"Grid types trend chart time item model."},"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."},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"Headings":{"properties":{"H1":{"items":{"type":"string"},"type":"array","title":"H1","default":[]},"H2":{"items":{"type":"string"},"type":"array","title":"H2","default":[]}},"type":"object","title":"Headings"},"ImagesInput":{"properties":{"account_id":{"type":"integer","title":"Account Id"},"se_group_id":{"type":"integer","title":"Se Group Id"},"url":{"type":"string","title":"Url"}},"type":"object","required":["account_id","se_group_id","url"],"title":"ImagesInput"},"KeywordActivityOut":{"properties":{"account_id":{"type":"integer","title":"Account Id"},"keyword_change_rate":{"type":"number","title":"Keyword Change Rate"}},"type":"object","required":["account_id","keyword_change_rate"],"title":"KeywordActivityOut"},"KeywordGroupDetail":{"properties":{"group_id":{"type":"integer","title":"Group Id"},"keyword_group_name":{"type":"string","title":"Keyword Group Name"}},"type":"object","required":["group_id","keyword_group_name"],"title":"KeywordGroupDetail"},"KeywordGroupDetailOut":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"keywords":{"items":{"$ref":"#/components/schemas/KeywordOut"},"type":"array","title":"Keywords"}},"type":"object","required":["id","name","keywords"],"title":"KeywordGroupDetailOut"},"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."},"KeywordGroupMetricsItem":{"properties":{"keywordgroup":{"type":"string","title":"Keywordgroup"},"keyword_group_id":{"type":"integer","title":"Keyword Group Id"},"time":{"type":"integer","title":"Time"},"parent_keyword_group_id":{"type":"integer","title":"Parent Keyword Group Id"},"search_volume":{"type":"integer","title":"Search Volume"},"avg_volume":{"type":"integer","title":"Avg Volume"},"clicks":{"type":"integer","title":"Clicks"},"product_grid_count":{"type":"number","title":"Product Grid Count"},"blended_rank":{"type":"number","title":"Blended Rank"},"tile_rank":{"type":"number","title":"Tile Rank"},"search_volume_previous_value":{"type":"integer","title":"Search Volume Previous Value"},"clicks_previous_value":{"type":"integer","title":"Clicks Previous Value"},"product_grid_count_previous_value":{"type":"number","title":"Product Grid Count Previous Value"},"tile_rank_previous_value":{"type":"number","title":"Tile Rank Previous Value"},"search_volume_diff":{"type":"integer","title":"Search Volume Diff"},"clicks_diff":{"type":"integer","title":"Clicks Diff"},"product_grid_count_diff":{"type":"integer","title":"Product Grid Count Diff"},"blended_rank_diff":{"type":"number","title":"Blended Rank Diff"},"tile_rank_diff":{"type":"number","title":"Tile Rank Diff"},"search_volume_diffpercent":{"type":"number","title":"Search Volume Diffpercent"},"clicks_diffpercent":{"type":"number","title":"Clicks Diffpercent"},"product_grid_count_diffpercent":{"type":"number","title":"Product Grid Count Diffpercent"},"blended_rank_diffpercent":{"type":"number","title":"Blended Rank Diffpercent"},"tile_rank_diffpercent":{"type":"number","title":"Tile Rank Diffpercent"},"both_no_product_grid_and_regular_listing_diffpercent":{"type":"number","title":"Both No Product Grid And Regular Listing Diffpercent"},"regular_listing_only_diffpercent":{"type":"number","title":"Regular Listing Only Diffpercent"},"product_grid_only_diffpercent":{"type":"number","title":"Product Grid Only Diffpercent"},"both_product_grid_and_regular_listing_diffpercent":{"type":"number","title":"Both Product Grid And Regular Listing Diffpercent"},"keywords_count":{"type":"integer","title":"Keywords Count"},"keywords_count_previous_value":{"type":"integer","title":"Keywords Count Previous Value"},"keywords_count_diff":{"type":"integer","title":"Keywords Count Diff"},"keywords_count_diffpercent":{"type":"number","title":"Keywords Count Diffpercent"},"opportunity_count":{"type":"number","title":"Opportunity Count"},"opportunity_count_previous_value":{"type":"number","title":"Opportunity Count Previous Value"},"product_grid_coverage_percentage":{"type":"number","title":"Product Grid Coverage Percentage"},"product_grid_coverage_percentage_previous_value":{"type":"number","title":"Product Grid Coverage Percentage Previous Value"},"product_grid_rank1_count":{"type":"number","title":"Product Grid Rank1 Count"},"product_grid_rank1_count_previous_value":{"type":"number","title":"Product Grid Rank1 Count Previous Value"},"product_grid_rank1_count_diff":{"type":"number","title":"Product Grid Rank1 Count Diff"},"product_grid_rank1_count_diffpercent":{"type":"number","title":"Product Grid Rank1 Count Diffpercent"},"avg_top_grid_rank":{"type":"number","title":"Avg Top Grid Rank"},"avg_top_grid_rank_previous_value":{"type":"number","title":"Avg Top Grid Rank Previous Value"},"avg_top_grid_rank_diff":{"type":"number","title":"Avg Top Grid Rank Diff"},"avg_top_grid_rank_diffpercent":{"type":"number","title":"Avg Top Grid Rank Diffpercent"},"avg_grid_count":{"type":"number","title":"Avg Grid Count"},"domain_product_grid_count":{"type":"number","title":"Domain Product Grid Count"},"search_volume_with_domain_presence":{"type":"number","title":"Search Volume With Domain Presence"},"search_volume_with_domain_presence_prev":{"type":"number","title":"Search Volume With Domain Presence Prev"},"avg_grid_count_with_domain_presence":{"type":"number","title":"Avg Grid Count With Domain Presence"}},"type":"object","required":["keywordgroup","keyword_group_id","time","parent_keyword_group_id","search_volume","avg_volume","clicks","product_grid_count","blended_rank","tile_rank","search_volume_previous_value","clicks_previous_value","product_grid_count_previous_value","tile_rank_previous_value","search_volume_diff","clicks_diff","product_grid_count_diff","blended_rank_diff","tile_rank_diff","search_volume_diffpercent","clicks_diffpercent","product_grid_count_diffpercent","blended_rank_diffpercent","tile_rank_diffpercent","both_no_product_grid_and_regular_listing_diffpercent","regular_listing_only_diffpercent","product_grid_only_diffpercent","both_product_grid_and_regular_listing_diffpercent","keywords_count","keywords_count_previous_value","keywords_count_diff","keywords_count_diffpercent","opportunity_count","opportunity_count_previous_value","product_grid_coverage_percentage","product_grid_coverage_percentage_previous_value","product_grid_rank1_count","product_grid_rank1_count_previous_value","product_grid_rank1_count_diff","product_grid_rank1_count_diffpercent","avg_top_grid_rank","avg_top_grid_rank_previous_value","avg_top_grid_rank_diff","avg_top_grid_rank_diffpercent","avg_grid_count","domain_product_grid_count","search_volume_with_domain_presence","search_volume_with_domain_presence_prev","avg_grid_count_with_domain_presence"],"title":"KeywordGroupMetricsItem"},"KeywordGroupMetricsResult":{"properties":{"data":{"items":{"$ref":"#/components/schemas/KeywordGroupMetricsItem"},"type":"array","title":"Data"},"total":{"type":"integer","title":"Total"}},"type":"object","required":["data","total"],"title":"KeywordGroupMetricsResult"},"KeywordGroupOut":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"}},"type":"object","required":["id","name"],"title":"KeywordGroupOut"},"KeywordGroupOutResp":{"properties":{"total":{"type":"integer","title":"Total"},"groups":{"items":{"$ref":"#/components/schemas/KeywordGroupOut"},"type":"array","title":"Groups"}},"type":"object","required":["total","groups"],"title":"KeywordGroupOutResp"},"KeywordGroups":{"properties":{"keyword_groups":{"items":{"$ref":"#/components/schemas/KeywordGroupDetail"},"type":"array","title":"Keyword Groups"}},"type":"object","required":["keyword_groups"],"title":"KeywordGroups"},"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","title":"Domain Presence Top Grid Rank Prev"},"grid_presence_ratio":{"type":"number","title":"Grid Presence Ratio"}},"type":"object","required":["id","keyword","group_titles","stores","search_volume","search_volume_diff","search_volume_diffpercent","clicks","clicks_diff","clicks_diffpercent","blended_rank","blended_rank_diff","blended_rank_diffpercent","tile_rank","tile_rank_diff","tile_rank_diffpercent","domain_presence_product_grids_count","total_product_grid_presence_count","domain_presence_top_grid_rank","domain_presence_top_grid_rank_diff","domain_presence_top_grid_rank_prev","grid_presence_ratio"],"title":"KeywordMetricsItem","description":"Keyword metrics item 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"},"KeywordOut":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"}},"type":"object","required":["id","name"],"title":"KeywordOut"},"KeywordOutWithGroup":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"keyword_group_id":{"type":"integer","title":"Keyword Group Id"}},"type":"object","required":["id","name","keyword_group_id"],"title":"KeywordOutWithGroup"},"KeywordOutWithGroupResp":{"properties":{"total":{"type":"integer","title":"Total"},"keywords":{"items":{"$ref":"#/components/schemas/KeywordOutWithGroup"},"type":"array","title":"Keywords"}},"type":"object","required":["keywords"],"title":"KeywordOutWithGroupResp"},"KeywordRequestWithGroup":{"properties":{"keyword":{"type":"string","title":"Keyword"}},"type":"object","required":["keyword"],"title":"KeywordRequestWithGroup"},"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."},"KeywordsWithProductGridPresenceInputModel":{"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"},"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":"Fetch result for page1 only"}},"type":"object","required":["account_id","time_frequency","search_engine"],"title":"KeywordsWithProductGridPresenceInputModel","description":"Base time range input model."},"KeywordsWithProductGridPresenceItem":{"properties":{"time":{"type":"integer","title":"Time"},"product_grid_presence_number":{"type":"integer","title":"Product Grid Presence Number"},"clicks":{"type":"integer","title":"Clicks"},"search_volume":{"type":"integer","title":"Search Volume"},"tile_rank":{"type":"number","title":"Tile Rank"},"blended_rank":{"type":"number","title":"Blended Rank"},"keywords_with_domain_presence":{"type":"integer","title":"Keywords With Domain Presence"},"avg_top_grid_rank":{"type":"number","title":"Avg Top Grid Rank"},"avg_grid_count":{"type":"number","title":"Avg Grid Count"}},"type":"object","required":["time","product_grid_presence_number","clicks","search_volume","tile_rank","blended_rank","keywords_with_domain_presence","avg_top_grid_rank","avg_grid_count"],"title":"KeywordsWithProductGridPresenceItem","description":"Keywords with product grid presence item model."},"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."},"KwIdeasHistoryOut":{"properties":{"total":{"type":"integer","title":"Total"},"count":{"type":"integer","title":"Count"},"offset":{"type":"integer","title":"Offset"},"values":{"items":{"$ref":"#/components/schemas/KwValue"},"type":"array","title":"Values"}},"type":"object","title":"KwIdeasHistoryOut"},"KwValue":{"properties":{"search_volume":{"type":"integer","title":"Search Volume"},"suggested_bid":{"type":"number","title":"Suggested Bid"},"num_words":{"type":"integer","title":"Num Words"},"competition":{"type":"string","title":"Competition"},"keyword":{"type":"string","title":"Keyword"}},"type":"object","required":["num_words","keyword"],"title":"KwValue"},"LegacyAccountIn":{"properties":{"excluded_keyword_group_filter":{"items":{"type":"string"},"type":"array","title":"Excluded Keyword Group Filter"}},"type":"object","title":"LegacyAccountIn"},"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"},"LegacyAccountShortOut":{"properties":{"id":{"type":"string","title":"Id"},"account":{"type":"string","title":"Account"}},"type":"object","required":["id","account"],"title":"LegacyAccountShortOut"},"LegacyAccountsListOut":{"properties":{"accounts":{"items":{"$ref":"#/components/schemas/LegacyAccountShortOut"},"type":"array","title":"Accounts"}},"type":"object","required":["accounts"],"title":"LegacyAccountsListOut"},"LegacyCompetitorDomainOut":{"properties":{"domains":{"items":{"$ref":"#/components/schemas/LegacyDomainShortOut"},"type":"array","title":"Domains"}},"type":"object","required":["domains"],"title":"LegacyCompetitorDomainOut"},"LegacyDatacubeSearchenginesOut":{"properties":{"searchengines":{"items":{"$ref":"#/components/schemas/LegacyDatacubeSearchenginesShortOut"},"type":"array","title":"Searchengines"}},"type":"object","required":["searchengines"],"title":"LegacyDatacubeSearchenginesOut"},"LegacyDatacubeSearchenginesShortOut":{"properties":{"id":{"type":"string","title":"Id"},"country":{"type":"string","title":"Country"},"location":{"type":"string","title":"Location"},"device_type":{"type":"string","title":"Device Type"},"searchengine":{"type":"string","title":"Searchengine"},"display_name":{"type":"string","title":"Display Name"},"device_type_id":{"type":"string","title":"Device Type Id"},"searchengine_group_id":{"type":"string","title":"Searchengine Group Id"}},"type":"object","required":["id","country","location","device_type","searchengine","display_name","device_type_id","searchengine_group_id"],"title":"LegacyDatacubeSearchenginesShortOut"},"LegacyDomainShortOut":{"properties":{"id":{"type":"string","title":"Id"},"domain":{"type":"string","title":"Domain"}},"type":"object","required":["id","domain"],"title":"LegacyDomainShortOut"},"LegacyKeywordGroupDetailKeywordShortOut":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"}},"type":"object","required":["id","name"],"title":"LegacyKeywordGroupDetailKeywordShortOut"},"LegacyKeywordGroupDetailOut":{"properties":{"keywordgroups":{"items":{"$ref":"#/components/schemas/LegacyKeywordGroupDetailShortOut"},"type":"array","title":"Keywordgroups"}},"type":"object","required":["keywordgroups"],"title":"LegacyKeywordGroupDetailOut"},"LegacyKeywordGroupDetailShortOut":{"properties":{"id":{"type":"string","title":"Id"},"keywordgroup":{"type":"string","title":"Keywordgroup"},"keywords":{"items":{"$ref":"#/components/schemas/LegacyKeywordGroupDetailKeywordShortOut"},"type":"array","title":"Keywords"}},"type":"object","required":["id","keywordgroup","keywords"],"title":"LegacyKeywordGroupDetailShortOut"},"LegacyKeywordGroupOut":{"properties":{"keywordgroups":{"items":{"$ref":"#/components/schemas/LegacyKeywordGroupShortOut"},"type":"array","title":"Keywordgroups"}},"type":"object","required":["keywordgroups"],"title":"LegacyKeywordGroupOut"},"LegacyKeywordGroupShortOut":{"properties":{"id":{"type":"string","title":"Id"},"keywordgroup":{"type":"string","title":"Keywordgroup"}},"type":"object","required":["id","keywordgroup"],"title":"LegacyKeywordGroupShortOut"},"LegacyKeywordOut":{"properties":{"count":{"type":"string","title":"Count"},"total":{"type":"string","title":"Total"},"offset":{"type":"string","title":"Offset"},"keywords":{"items":{"$ref":"#/components/schemas/LegacyKeywordShortOut"},"type":"array","title":"Keywords"}},"type":"object","required":["count","total","offset","keywords"],"title":"LegacyKeywordOut"},"LegacyKeywordShortOut":{"properties":{"id":{"type":"string","title":"Id"},"keyword":{"type":"string","title":"Keyword"}},"type":"object","required":["id","keyword"],"title":"LegacyKeywordShortOut"},"LegacySearchenginesOut":{"properties":{"searchengines":{"items":{"$ref":"#/components/schemas/LegacySearchenginesShortOut"},"type":"array","title":"Searchengines"}},"type":"object","required":["searchengines"],"title":"LegacySearchenginesOut"},"LegacySearchenginesShortOut":{"properties":{"display_name":{"type":"string","title":"Display Name"},"country":{"type":"string","title":"Country"},"searchengine":{"type":"string","title":"Searchengine"},"location":{"type":"string","title":"Location"},"device_type":{"type":"string","title":"Device Type"},"device_type_id":{"type":"string","title":"Device Type Id"},"searchengine_group_id":{"type":"string","title":"Searchengine Group Id"},"id":{"type":"string","title":"Id"}},"type":"object","required":["display_name","country","searchengine","location","device_type","device_type_id","searchengine_group_id","id"],"title":"LegacySearchenginesShortOut"},"LegacyTimeFrequencyOut":{"properties":{"time_value":{"type":"string","title":"Time Value"},"day_value":{"type":"string","title":"Day Value"},"time_frequency":{"$ref":"#/components/schemas/TimeTimeStringType"}},"type":"object","required":["time_value","day_value","time_frequency"],"title":"LegacyTimeFrequencyOut"},"LocationDetailConfigV2":{"properties":{"be_account_id":{"type":"integer","title":"Be Account Id"},"location_name":{"type":"string","title":"Location Name"},"column_names":{"items":{},"type":"array","title":"Column Names"},"q":{"type":"string","title":"Q"},"all":{"type":"boolean","title":"All","default":false}},"type":"object","required":["be_account_id"],"title":"LocationDetailConfigV2"},"MarketoCacheRequest":{"properties":{"url":{"type":"string","minLength":1,"title":"Url"}},"type":"object","required":["url"],"title":"MarketoCacheRequest"},"MarketoPaaRequest":{"properties":{"collector_id":{"type":"integer","title":"Collector Id","default":34},"keyword":{"type":"string","minLength":1,"title":"Keyword"},"limit":{"type":"integer","maximum":4.0,"exclusiveMinimum":0.0,"title":"Limit","default":4}},"type":"object","required":["keyword"],"title":"MarketoPaaRequest"},"MarketoPaaResponse":{"properties":{"status":{"type":"boolean","title":"Status"},"message":{"type":"string","title":"Message"},"info":{"$ref":"#/components/schemas/MarketoResponseInfo"},"data":{"$ref":"#/components/schemas/MarketoPaaResponseData"}},"type":"object","required":["status","message","info","data"],"title":"MarketoPaaResponse"},"MarketoPaaResponseData":{"properties":{"keyword":{"type":"string","title":"Keyword"},"questions":{"items":{"$ref":"#/components/schemas/MarketoPaaResponseDataItem"},"type":"array","title":"Questions"}},"type":"object","title":"MarketoPaaResponseData"},"MarketoPaaResponseDataItem":{"properties":{"rank":{"type":"integer","title":"Rank"},"display_title":{"type":"string","title":"Display Title"},"answer_text":{"type":"string","title":"Answer Text"},"landing_url":{"type":"string","title":"Landing Url"}},"type":"object","title":"MarketoPaaResponseDataItem"},"MarketoResponseInfo":{"properties":{"version":{"type":"string","title":"Version"},"timestamp":{"type":"number","title":"Timestamp"}},"type":"object","required":["version","timestamp"],"title":"MarketoResponseInfo"},"MarketoTopKeywordsPerDomainRequest":{"properties":{"collector_id":{"type":"integer","title":"Collector Id","default":34},"domain":{"type":"string","minLength":1,"title":"Domain"},"limit":{"type":"integer","maximum":1000.0,"exclusiveMinimum":0.0,"title":"Limit","default":100}},"type":"object","required":["domain"],"title":"MarketoTopKeywordsPerDomainRequest"},"MarketoTopKeywordsPerDomainResponse":{"properties":{"status":{"type":"boolean","title":"Status"},"message":{"type":"string","title":"Message"},"info":{"$ref":"#/components/schemas/MarketoResponseInfo"},"data":{"$ref":"#/components/schemas/MarketoTopKeywordsPerDomainResponseData"}},"type":"object","required":["status","message","info","data"],"title":"MarketoTopKeywordsPerDomainResponse"},"MarketoTopKeywordsPerDomainResponseData":{"properties":{"keywords":{"items":{"$ref":"#/components/schemas/MarketoTopKeywordsPerDomainResponseDataItem"},"type":"array","title":"Keywords"}},"type":"object","title":"MarketoTopKeywordsPerDomainResponseData"},"MarketoTopKeywordsPerDomainResponseDataItem":{"properties":{"keyword":{"type":"string","title":"Keyword"},"volume":{"type":"integer","title":"Volume"},"blended_rank":{"type":"integer","title":"Blended Rank"},"est_visits":{"type":"integer","title":"Est Visits"},"top_url":{"type":"string","title":"Top Url"}},"type":"object","title":"MarketoTopKeywordsPerDomainResponseDataItem"},"MarketoTopKeywordsPerPageRequest":{"properties":{"collector_id":{"type":"integer","title":"Collector Id","default":34},"page":{"type":"string","minLength":1,"title":"Page"},"limit":{"type":"integer","maximum":5.0,"exclusiveMinimum":0.0,"title":"Limit","default":5}},"type":"object","required":["page"],"title":"MarketoTopKeywordsPerPageRequest"},"MarketoTopKeywordsPerPageResponse":{"properties":{"status":{"type":"boolean","title":"Status"},"message":{"type":"string","title":"Message"},"info":{"$ref":"#/components/schemas/MarketoResponseInfo"},"data":{"$ref":"#/components/schemas/MarketoTopKeywordsPerPageResponseData"}},"type":"object","required":["status","message","info","data"],"title":"MarketoTopKeywordsPerPageResponse"},"MarketoTopKeywordsPerPageResponseData":{"properties":{"keywords":{"items":{"$ref":"#/components/schemas/MarketoTopKeywordsPerPageResponseDataItem"},"type":"array","title":"Keywords"}},"type":"object","title":"MarketoTopKeywordsPerPageResponseData"},"MarketoTopKeywordsPerPageResponseDataItem":{"properties":{"keyword":{"type":"string","title":"Keyword"},"volume":{"type":"integer","title":"Volume"},"blended_rank":{"type":"integer","title":"Blended Rank"}},"type":"object","title":"MarketoTopKeywordsPerPageResponseDataItem"},"MarketoTopPagesRequest":{"properties":{"collector_id":{"type":"integer","title":"Collector Id","default":34},"domain":{"type":"string","minLength":1,"title":"Domain"},"limit":{"type":"integer","maximum":1000.0,"exclusiveMinimum":0.0,"title":"Limit","default":1000}},"type":"object","required":["domain"],"title":"MarketoTopPagesRequest"},"MarketoTopPagesResponse":{"properties":{"status":{"type":"boolean","title":"Status"},"message":{"type":"string","title":"Message"},"info":{"$ref":"#/components/schemas/MarketoResponseInfo"},"data":{"$ref":"#/components/schemas/MarketoTopPagesResponseData"}},"type":"object","required":["status","message","info","data"],"title":"MarketoTopPagesResponse"},"MarketoTopPagesResponseData":{"properties":{"pages":{"items":{"$ref":"#/components/schemas/MarketoTopPagesResponseDataItem"},"type":"array","title":"Pages"}},"type":"object","title":"MarketoTopPagesResponseData"},"MarketoTopPagesResponseDataItem":{"properties":{"url":{"type":"string","title":"Url"},"search_vol":{"type":"integer","title":"Search Vol"},"average_rank":{"type":"integer","title":"Average Rank"},"est_visits":{"type":"integer","title":"Est Visits"}},"type":"object","title":"MarketoTopPagesResponseDataItem"},"OrgAccountDetailOut":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"created_on_date":{"type":"string","format":"date-time","title":"Created On Date"}},"type":"object","required":["id","name","created_on_date"],"title":"OrgAccountDetailOut"},"OrganizationOut":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"created_on":{"type":"string","format":"date-time","title":"Created On"},"max_accounts":{"type":"integer","title":"Max Accounts"},"max_competitors":{"type":"integer","title":"Max Competitors"}},"type":"object","required":["id","name","created_on","max_accounts","max_competitors"],"title":"OrganizationOut"},"OrganizationUsersOutput":{"properties":{"total_pages":{"type":"integer","title":"Total Pages"},"users":{"items":{"$ref":"#/components/schemas/UserOutput"},"type":"array","title":"Users"}},"type":"object","required":["total_pages","users"],"title":"OrganizationUsersOutput"},"OutputType":{"type":"string","enum":["parsed","raw","summary_only"],"title":"OutputType","description":"Output type for data requests"},"PSKeywords":{"properties":{"primary_keyword":{"type":"string","title":"Primary Keyword"},"secondary_keywords":{"type":"string","title":"Secondary Keywords"}},"type":"object","title":"PSKeywords"},"PageDetails":{"properties":{"url":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Url"},"canonical_url":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Canonical Url"},"title":{"type":"string","title":"Title"},"meta_description":{"type":"string","title":"Meta Description"},"yearweek":{"type":"integer","title":"Yearweek"}},"type":"object","required":["url","canonical_url","title","yearweek"],"title":"PageDetails"},"PageDetailsInput":{"properties":{"account_id":{"type":"integer","title":"Account Id"},"url":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Url"},"title":{"type":"string","title":"Title","default":""},"meta_description":{"type":"string","title":"Meta Description","default":""}},"type":"object","required":["account_id","url"],"title":"PageDetailsInput"},"Pagination":{"properties":{"offset":{"type":"integer","title":"Offset","default":0},"limit":{"type":"integer","title":"Limit","default":25}},"type":"object","title":"Pagination"},"PaginationInput":{"properties":{"limit":{"type":"integer","title":"Limit","default":30000},"offset":{"type":"integer","title":"Offset","default":0}},"type":"object","title":"PaginationInput","description":"Pagination input model."},"PeopleAlsoAskChatgptIn":{"properties":{"keyword":{"type":"string","title":"Keyword"}},"type":"object","required":["keyword"],"title":"PeopleAlsoAskChatgptIn"},"PeopleAlsoAskChatgptOut":{"properties":{"questions":{"items":{"$ref":"#/components/schemas/PeopleAlsoAskQuestionsChatgpt"},"type":"array","title":"Questions"},"assistant":{"type":"string","title":"Assistant"}},"type":"object","required":["questions"],"title":"PeopleAlsoAskChatgptOut"},"PeopleAlsoAskHistoricalIn":{"properties":{"keyword":{"type":"string","title":"Keyword"},"collector_id":{"type":"integer","title":"Collector Id"},"num_of_weeks_back":{"type":"integer","title":"Num Of Weeks Back"}},"type":"object","required":["keyword","collector_id"],"title":"PeopleAlsoAskHistoricalIn"},"PeopleAlsoAskHistoricalOut":{"properties":{"questions":{"items":{"$ref":"#/components/schemas/PeopleAlsoAskQuestions"},"type":"array","title":"Questions"}},"type":"object","required":["questions"],"title":"PeopleAlsoAskHistoricalOut"},"PeopleAlsoAskIn":{"properties":{"keyword":{"type":"string","title":"Keyword"},"collector_id":{"type":"integer","title":"Collector Id"},"live":{"type":"boolean","title":"Live"},"historical":{"type":"boolean","title":"Historical"},"chatgpt":{"type":"boolean","title":"Chatgpt"},"click_depth":{"type":"integer","title":"Click Depth"},"num_of_weeks_back":{"type":"integer","title":"Num Of Weeks Back"},"max_num_of_results":{"type":"integer","title":"Max Num Of Results"}},"type":"object","required":["keyword","collector_id"],"title":"PeopleAlsoAskIn"},"PeopleAlsoAskLiveIn":{"properties":{"keyword":{"type":"string","title":"Keyword"},"collector_id":{"type":"integer","title":"Collector Id"},"click_depth":{"type":"integer","title":"Click Depth"}},"type":"object","required":["keyword","collector_id"],"title":"PeopleAlsoAskLiveIn"},"PeopleAlsoAskLiveOut":{"properties":{"questions":{"items":{"$ref":"#/components/schemas/PeopleAlsoAskQuestionsLive"},"type":"array","title":"Questions"}},"type":"object","required":["questions"],"title":"PeopleAlsoAskLiveOut"},"PeopleAlsoAskOut":{"properties":{"questions_live":{"items":{"$ref":"#/components/schemas/PeopleAlsoAskQuestionsLive"},"type":"array","title":"Questions Live"},"questions_historical":{"items":{"$ref":"#/components/schemas/PeopleAlsoAskQuestionsLive"},"type":"array","title":"Questions Historical"},"questions_chatgpt":{"items":{"$ref":"#/components/schemas/PeopleAlsoAskQuestionsChatgpt"},"type":"array","title":"Questions Chatgpt"}},"type":"object","required":["questions_live","questions_historical","questions_chatgpt"],"title":"PeopleAlsoAskOut"},"PeopleAlsoAskQuestions":{"properties":{"keyword":{"type":"string","title":"Keyword"},"collector_id":{"type":"integer","title":"Collector Id"},"display_title":{"type":"string","title":"Display Title"},"answer_text":{"type":"string","title":"Answer Text"},"landing_url_title":{"type":"string","title":"Landing Url Title"},"landing_url":{"type":"string","title":"Landing Url"}},"type":"object","required":["keyword","collector_id"],"title":"PeopleAlsoAskQuestions"},"PeopleAlsoAskQuestionsChatgpt":{"properties":{"title":{"type":"string","title":"Title"}},"type":"object","title":"PeopleAlsoAskQuestionsChatgpt"},"PeopleAlsoAskQuestionsLive":{"properties":{"title":{"type":"string","title":"Title"},"answer_text":{"type":"string","title":"Answer Text"},"description":{"type":"string","title":"Description"},"url":{"type":"string","title":"Url"}},"type":"object","title":"PeopleAlsoAskQuestionsLive"},"PresenceTrendChartItem":{"properties":{"time":{"type":"integer","title":"Time"},"product_grid_presence":{"type":"integer","title":"Product Grid Presence"},"only_product_grid":{"type":"integer","title":"Only Product Grid"},"regular_presence":{"type":"integer","title":"Regular Presence"},"all_presence":{"type":"integer","title":"All Presence"},"absent":{"type":"integer","title":"Absent"},"total_keywords":{"type":"integer","title":"Total Keywords"}},"type":"object","required":["time","product_grid_presence","only_product_grid","regular_presence","all_presence","absent"],"title":"PresenceTrendChartItem","description":"Keywords with product grid presence item model."},"PresenceTrendChartResult":{"properties":{"data":{"items":{"$ref":"#/components/schemas/PresenceTrendChartItem"},"type":"array","title":"Data"},"total":{"type":"integer","title":"Total"}},"type":"object","required":["data","total"],"title":"PresenceTrendChartResult","description":"Presence trend chart result model."},"RecommendationKw":{"properties":{"keyword_id":{"type":"integer","title":"Keyword Id"},"name":{"type":"string","title":"Name"},"search_volume":{"type":"integer","title":"Search Volume"},"position":{"type":"integer","title":"Position"},"plp_url":{"type":"string","title":"Plp Url"},"plp_url_id":{"type":"string","title":"Plp Url Id"}},"type":"object","required":["keyword_id","name","position","plp_url","plp_url_id"],"title":"RecommendationKw"},"RecommendationKwChangePriorityRequest":{"properties":{"plp_url_id":{"type":"string","title":"Plp Url Id"},"keywords":{"items":{"$ref":"#/components/schemas/RecommendationKwPriority"},"type":"array","title":"Keywords"}},"type":"object","required":["plp_url_id","keywords"],"title":"RecommendationKwChangePriorityRequest"},"RecommendationKwListRequest":{"properties":{"page_url":{"type":"string","title":"Page Url"},"page_url_id":{"type":"integer","title":"Page Url Id"}},"type":"object","title":"RecommendationKwListRequest"},"RecommendationKwListResponse":{"properties":{"page_url_id":{"type":"integer","title":"Page Url Id"},"page_url_name":{"type":"string","title":"Page Url Name"},"active_keywords":{"items":{"$ref":"#/components/schemas/RecommendationKw"},"type":"array","title":"Active Keywords"},"inactive_keywords":{"items":{"$ref":"#/components/schemas/RecommendationKw"},"type":"array","title":"Inactive Keywords"}},"type":"object","required":["active_keywords","inactive_keywords"],"title":"RecommendationKwListResponse"},"RecommendationKwPriority":{"properties":{"keyword_id":{"type":"integer","title":"Keyword Id"},"position":{"type":"integer","title":"Position"}},"type":"object","required":["keyword_id","position"],"title":"RecommendationKwPriority"},"RecommendationOut":{"properties":{"account_id":{"type":"integer","title":"Account Id"},"total_pages":{"type":"integer","title":"Total Pages"},"rules":{"items":{},"type":"array","title":"Rules"}},"type":"object","required":["account_id","total_pages","rules"],"title":"RecommendationOut"},"ResearchKeywordsInput":{"properties":{"keyword":{"type":"string","title":"Keyword"},"se_group_id":{"type":"string","title":"Se Group Id"},"account_id":{"type":"integer","title":"Account Id"}},"type":"object","required":["keyword","se_group_id","account_id"],"title":"ResearchKeywordsInput"},"ResponseMetadata":{"properties":{"dimensionOptions":{"$ref":"#/components/schemas/DimensionOptionsMetadata"},"dimensions":{"items":{"type":"string"},"type":"array","title":"Dimensions"},"measures":{"items":{"type":"string"},"type":"array","title":"Measures"}},"type":"object","title":"ResponseMetadata","description":"Metadata included in V2 response"},"SaveGMBMultiEdit":{"properties":{"be_account_id":{"type":"integer","title":"Be Account Id"},"changes":{"items":{"type":"object"},"type":"array","title":"Changes"},"multi_edit_id":{"type":"string","title":"Multi Edit Id"},"batch_attribute_update":{"type":"boolean","title":"Batch Attribute Update","default":false}},"type":"object","required":["be_account_id","changes","multi_edit_id"],"title":"SaveGMBMultiEdit"},"SearchEngineOut":{"properties":{"id":{"type":"integer","title":"Id"},"country":{"type":"string","title":"Country"},"location":{"type":"string","title":"Location"},"device_type":{"type":"string","title":"Device Type"},"name":{"type":"string","title":"Name"},"se_group_id":{"type":"string","title":"Se Group Id"}},"type":"object","required":["id","country","location","device_type","name","se_group_id"],"title":"SearchEngineOut"},"SiteAuditCrawlReportOut":{"properties":{"account_id":{"type":"integer","title":"Account Id"},"yearweek":{"type":"integer","title":"Yearweek"},"crawl_id":{"type":"integer","title":"Crawl Id"},"page_type":{"type":"string","title":"Page Type"},"preset":{"type":"string","title":"Preset"},"crawl_completed_date":{"type":"string","title":"Crawl Completed Date"},"total_pages_crawled":{"type":"integer","title":"Total Pages Crawled"},"error_code":{"type":"integer","title":"Error Code"},"crawl_status":{"type":"integer","title":"Crawl Status"},"page_details":{"items":{"type":"object"},"type":"array","title":"Page Details"}},"type":"object","required":["account_id","yearweek","crawl_id","page_type","preset","crawl_completed_date","total_pages_crawled","error_code","crawl_status","page_details"],"title":"SiteAuditCrawlReportOut"},"SiteAuditDimensionsIn":{"properties":{"time":{"type":"string","title":"Time"}},"type":"object","required":["time"],"title":"SiteAuditDimensionsIn"},"SiteAuditPageGroupIn":{"properties":{"filters":{"items":{"items":{},"type":"array"},"type":"array","title":"Filters"},"dimensionOptions":{"$ref":"#/components/schemas/SiteAuditDimensionsIn"},"order":{"items":{"items":{},"type":"array"},"type":"array","title":"Order"},"offset":{"items":{"type":"integer"},"type":"array","title":"Offset"}},"type":"object","required":["filters","dimensionOptions"],"title":"SiteAuditPageGroupIn"},"SiteAuditPageGroupOut":{"properties":{"total":{"type":"integer","title":"Total"},"count":{"type":"integer","title":"Count"},"results":{"items":{"$ref":"#/components/schemas/SiteAuditResultsOut"},"type":"array","title":"Results"}},"type":"object","required":["total","count","results"],"title":"SiteAuditPageGroupOut"},"SiteAuditReportIn":{"properties":{"filters":{"items":{"items":{},"type":"array"},"type":"array","title":"Filters"},"offset":{"items":{"type":"integer"},"type":"array","title":"Offset"}},"type":"object","required":["filters"],"title":"SiteAuditReportIn"},"SiteAuditReportOut":{"properties":{"total":{"type":"integer","title":"Total"},"count":{"type":"integer","title":"Count"},"results":{"items":{"$ref":"#/components/schemas/SiteAuditCrawlReportOut"},"type":"array","title":"Results"}},"type":"object","required":["total","count","results"],"title":"SiteAuditReportOut"},"SiteAuditResultsOut":{"properties":{"account_id":{"type":"integer","title":"Account Id"},"time":{"type":"integer","title":"Time"},"time_frequency":{"type":"string","title":"Time Frequency"},"crawl_id":{"type":"integer","title":"Crawl Id"},"page_type":{"type":"integer","title":"Page Type"},"preset":{"type":"string","title":"Preset"},"crawl_completed_date":{"type":"string","title":"Crawl Completed Date"},"total_pages_crawled":{"type":"integer","title":"Total Pages Crawled"},"crawl_status":{"type":"integer","title":"Crawl Status"},"error_code":{"type":"integer","title":"Error Code"},"rules":{"items":{"$ref":"#/components/schemas/SiteAuditRulesOut"},"type":"array","title":"Rules"}},"type":"object","required":["account_id","time","time_frequency","crawl_id","page_type","preset","crawl_completed_date","total_pages_crawled","crawl_status","error_code","rules"],"title":"SiteAuditResultsOut"},"SiteAuditRulesOut":{"properties":{"description":{"type":"string","title":"Description"},"custom":{"type":"boolean","title":"Custom"},"value":{"type":"integer","title":"Value"}},"type":"object","required":["description","custom","value"],"title":"SiteAuditRulesOut"},"StoreUpdatesConfig":{"properties":{"be_account_id":{"type":"integer","title":"Be Account Id"},"store_code":{"type":"string","title":"Store Code"},"before_value":{"type":"object","title":"Before Value"},"after_value":{"type":"object","title":"After Value"},"update_mask":{"type":"string","title":"Update Mask"},"language_code":{"type":"string","title":"Language Code","default":"en"}},"type":"object","required":["be_account_id","store_code"],"title":"StoreUpdatesConfig"},"TimeFrequencyOut":{"properties":{"time_value":{"type":"integer","title":"Time Value"},"day_value":{"type":"integer","title":"Day Value"},"time_frequency":{"$ref":"#/components/schemas/TimeTimeStringType"}},"type":"object","required":["time_value","day_value","time_frequency"],"title":"TimeFrequencyOut"},"TimeTimeStringType":{"type":"string","enum":["daily","weekly","monthly","quarterly","yearly","fiscal_weekly","fiscal_monthly","fiscal_quarterly","fiscal_yearly"],"title":"TimeTimeStringType","description":"An enumeration."},"TopProductsTrendChartInputModel":{"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 num1 filter"}},"type":"object","required":["account_id","time_frequency","search_engine"],"title":"TopProductsTrendChartInputModel","description":"Input model for top products trend chart."},"TopProductsTrendChartResult":{"properties":{"data":{"items":{"type":"object"},"type":"array","title":"Data"},"total":{"type":"integer","title":"Total"}},"type":"object","required":["data","total"],"title":"TopProductsTrendChartResult"},"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."},"TopSellersTrendChartResult":{"properties":{"data":{"items":{"type":"object"},"type":"array","title":"Data"},"total":{"type":"integer","title":"Total"}},"type":"object","required":["data","total"],"title":"TopSellersTrendChartResult"},"TrackKeywordsInput":{"properties":{"account_id":{"type":"integer","title":"Account Id"},"pagination":{"$ref":"#/components/schemas/Pagination"}},"type":"object","required":["account_id"],"title":"TrackKeywordsInput"},"UpdateFieldsGmbConfig":{"properties":{"be_account_id":{"type":"integer","title":"Be Account Id"},"account_name":{"type":"string","title":"Account Name"},"location_name":{"type":"string","title":"Location Name"},"before_value":{"type":"object","title":"Before Value"},"after_value":{"type":"object","title":"After Value"},"request_body":{"type":"object","title":"Request Body"},"task_id":{"type":"string","title":"Task Id"},"update_mask":{"type":"string","title":"Update Mask"},"attribute_mask":{"type":"string","title":"Attribute Mask"},"task_status":{"type":"integer","title":"Task Status","default":2}},"type":"object","required":["location_name"],"title":"UpdateFieldsGmbConfig"},"UpdateUserRequest":{"properties":{"login":{"type":"string","format":"email","title":"Login","description":"User login/email"},"firstname":{"type":"string","title":"Firstname","description":"User's first name"},"lastname":{"type":"string","title":"Lastname","description":"User's last name"},"email":{"type":"string","format":"email","title":"Email","description":"User's email"},"title":{"type":"string","title":"Title","description":"User's title"},"phone":{"type":"string","title":"Phone","description":"User's phone number"},"locale":{"type":"string","title":"Locale","description":"User's locale"},"profile":{"type":"integer","title":"Profile","description":"Users's profile"},"address":{"type":"string","title":"Address"}},"type":"object","required":["login"],"title":"UpdateUserRequest"},"UserAccountAccessRequest":{"properties":{"login":{"type":"string","format":"email","title":"Login","description":"User login/email"},"account_ids":{"items":{"type":"integer"},"type":"array","title":"Account Ids","description":"List of account IDs to change access"}},"type":"object","required":["login","account_ids"],"title":"UserAccountAccessRequest"},"UserAccountAccessResponse":{"properties":{"success":{"type":"boolean","title":"Success"},"message":{"type":"string","title":"Message"},"access_modified_account_ids":{"items":{"type":"integer"},"type":"array","title":"Access Modified Account Ids","description":"List of account IDs access changed"}},"type":"object","required":["success","message"],"title":"UserAccountAccessResponse"},"UserCreateResponse":{"properties":{"success":{"type":"boolean","title":"Success"},"message":{"type":"string","title":"Message"}},"type":"object","required":["success","message"],"title":"UserCreateResponse"},"UserDeleteResponse":{"properties":{"message":{"type":"string","title":"Message"}},"type":"object","required":["message"],"title":"UserDeleteResponse"},"UserOutput":{"properties":{"first_name":{"type":"string","title":"First Name"},"last_name":{"type":"string","title":"Last Name"},"email":{"type":"string","title":"Email"},"accounts":{"items":{"type":"string"},"type":"array","title":"Accounts"}},"type":"object","required":["email","accounts"],"title":"UserOutput"},"UserUpdateResponse":{"properties":{"status":{"type":"boolean","title":"Status"},"message":{"type":"string","title":"Message"}},"type":"object","required":["status","message"],"title":"UserUpdateResponse"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"WebVitals":{"properties":{"lcp":{"type":"string","title":"Lcp","default":""},"fid":{"type":"string","title":"Fid","default":""},"cls":{"type":"string","title":"Cls","default":""},"inp":{"type":"string","title":"Inp","default":""}},"type":"object","title":"WebVitals"}},"securitySchemes":{"http_basic":{"type":"http","scheme":"basic"},"forwarded_http_basic":{"type":"apiKey","in":"header","name":"X-Forwarded-Authorization"},"session_cookie":{"type":"apiKey","in":"cookie","name":"BRIGHTEDGE"},"session_header":{"type":"apiKey","in":"header","name":"X-BRIGHTEDGE-SESSION"},"api_token_header":{"type":"apiKey","in":"header","name":"X-Token"},"bearer_token":{"type":"apiKey","in":"header","name":"Bearer-Token"}}},"tags":[{"name":"authentication","description":"Operation related to authentication"},{"name":"accounts","description":"Operation related to accounts"},{"name":"domains","description":"Operation related to domains"},{"name":"keywords","description":"Operation related to keywords"},{"name":"keywordgroups","description":"Operation related to keyword groups"},{"name":"query","description":"Retrieving data with BQL queries"},{"name":"legacy","description":"Operation ported over from legacy API"},{"name":"organizations","description":"Operation related to organizations"},{"name":"backlinks","description":"Operation related to backlinks"},{"name":"searchengines","description":"Operation related to search engines"},{"name":"be_local","description":"Operation related to BE Local"},{"name":"users","description":"Operation related to users"},{"name":"time","description":"Operation related to time"},{"name":"marketinsights","description":"Operation related to Market Insights"},{"name":"chromeextension","description":"Supports ChromeExtension functionality."},{"name":"Serp Features","description":"Operation related to Serp features like People Also Ask etc"},{"name":"marketo","description":"APIs for marketo"},{"name":"dataset","description":"APIs for brightedge dataset"},{"name":"ai_catalyst","description":"APIs for ai_catalyst dataset"},{"name":"product_grid","description":"APIs for product grid"}]}