# Client ## Get Aggregated Prompts **post** `/api/beta/prompts` Returns metrics for all prompts with frequency over time topic ID ### Returns - **answerText:** `string` - **importantTerms:** `array of string` - **invocations:** `number` - **latestRunData:** `string` - **mentionFrequency:** `object` - **average:** `number` - **dataFormat:** `"NUMBER" OR "PERCENTAGE" OR "CURRENCY" OR 2 more` - `"NUMBER"` - `"PERCENTAGE"` - `"CURRENCY"` - `"TEXT"` - `"SCORE"` - **dates:** `array of string` - **daysSpan:** `number` - **delta:** `number` - **displayName:** `string` - **fromDate:** `string` - **language:** `"ENGLISH" OR "SPANISH" OR "PORTUGUESE" OR 9 more` - `"ENGLISH"` - `"SPANISH"` - `"PORTUGUESE"` - `"HEBREW"` - `"GERMAN"` - `"ITALIAN"` - `"FRENCH"` - `"MANDARIN"` - `"HINDI"` - `"ARABIC"` - `"JAPANESE"` - `"RUSSIAN"` - **locale:** `"GLOBAL" OR "ISRAEL" OR "EU" OR 97 more` - `"GLOBAL"` - `"ISRAEL"` - `"EU"` - `"UK"` - `"US"` - `"IL"` - `"AL"` - `"AZ"` - `"KG"` - `"BA"` - `"UZ"` - `"BI"` - `"XK"` - `"SM"` - `"DE"` - `"AT"` - `"CH"` - `"IE"` - `"IM"` - `"FR"` - `"ES"` - `"NL"` - `"IT"` - `"PT"` - `"BE"` - `"AD"` - `"MT"` - `"MC"` - `"MA"` - `"LU"` - `"TN"` - `"DZ"` - `"GI"` - `"LI"` - `"SE"` - `"DK"` - `"FI"` - `"NO"` - `"AX"` - `"IS"` - `"GG"` - `"JE"` - `"GL"` - `"VA"` - `"FX"` - `"FO"` - `"AF"` - `"AM"` - `"AU"` - `"BH"` - `"BD"` - `"BT"` - `"BN"` - `"KH"` - `"CN"` - `"CY"` - `"GE"` - `"HK"` - `"IN"` - `"ID"` - `"IR"` - `"IQ"` - `"JP"` - `"JO"` - `"KZ"` - `"KW"` - `"LA"` - `"LB"` - `"MY"` - `"MV"` - `"MN"` - `"MM"` - `"NP"` - `"OM"` - `"PK"` - `"PH"` - `"QA"` - `"SA"` - `"SG"` - `"KR"` - `"LK"` - `"SY"` - `"TW"` - `"TH"` - `"TR"` - `"AE"` - `"VN"` - `"YE"` - `"AR"` - `"BO"` - `"BR"` - `"CL"` - `"CO"` - `"EC"` - `"GY"` - `"PY"` - `"PE"` - `"SR"` - `"UY"` - `"VE"` - **median:** `number` - **metricName:** `string` - **series:** `array of object` - **date:** `string` - **value:** `number` - **toDate:** `string` - **value:** `number` - **negativeSentiments:** `array of map[string]` - **positiveSentiments:** `array of map[string]` - **prompt:** `string` - **promptAnalysisId:** `string` - **promptId:** `string` - **promptsCount:** `number` - **ranking:** `number` - **seoMetrics:** `object` - **cpc:** `number` - **searchVolume:** `number` - **shareOfVoice:** `number` - **sources:** `array of string` ## Get Metadata **get** `/api/beta/metadata` Returns all metadata by website ID ### Returns - **id:** `string` - **llmProvider:** `string` - **prompts:** `array of object` - **id:** `string` - **language:** `"ENGLISH" OR "SPANISH" OR "PORTUGUESE" OR 9 more` - `"ENGLISH"` - `"SPANISH"` - `"PORTUGUESE"` - `"HEBREW"` - `"GERMAN"` - `"ITALIAN"` - `"FRENCH"` - `"MANDARIN"` - `"HINDI"` - `"ARABIC"` - `"JAPANESE"` - `"RUSSIAN"` - **text:** `string` - **text:** `string` ## Get Prompt **get** `/api/beta/prompts` Returns all related metrics data by prompt ID ### Returns - **id:** `string` - **answerText:** `string` - **brightDataPromptIndex:** `number` - **completePostProcess:** `boolean` - **created:** `string` - **data:** `object` - **importantTerms:** `array of string` - **mentions:** `map[number]` - **negativeSentiment:** `array of map[string]` - **positiveSentiments:** `array of map[string]` - **ranking:** `map[number]` - **sentimentScore:** `map[number]` - **sources:** `array of string` - **language:** `"ENGLISH" OR "SPANISH" OR "PORTUGUESE" OR 9 more` - `"ENGLISH"` - `"SPANISH"` - `"PORTUGUESE"` - `"HEBREW"` - `"GERMAN"` - `"ITALIAN"` - `"FRENCH"` - `"MANDARIN"` - `"HINDI"` - `"ARABIC"` - `"JAPANESE"` - `"RUSSIAN"` - **llmProvider:** `"openai/gpt-4o" OR "openai/gpt-4o-search-preview" OR "perplexity" OR "gemini"` - `"openai/gpt-4o"` - `"openai/gpt-4o-search-preview"` - `"perplexity"` - `"gemini"` - **locale:** `"GLOBAL" OR "ISRAEL" OR "EU" OR 97 more` - `"GLOBAL"` - `"ISRAEL"` - `"EU"` - `"UK"` - `"US"` - `"IL"` - `"AL"` - `"AZ"` - `"KG"` - `"BA"` - `"UZ"` - `"BI"` - `"XK"` - `"SM"` - `"DE"` - `"AT"` - `"CH"` - `"IE"` - `"IM"` - `"FR"` - `"ES"` - `"NL"` - `"IT"` - `"PT"` - `"BE"` - `"AD"` - `"MT"` - `"MC"` - `"MA"` - `"LU"` - `"TN"` - `"DZ"` - `"GI"` - `"LI"` - `"SE"` - `"DK"` - `"FI"` - `"NO"` - `"AX"` - `"IS"` - `"GG"` - `"JE"` - `"GL"` - `"VA"` - `"FX"` - `"FO"` - `"AF"` - `"AM"` - `"AU"` - `"BH"` - `"BD"` - `"BT"` - `"BN"` - `"KH"` - `"CN"` - `"CY"` - `"GE"` - `"HK"` - `"IN"` - `"ID"` - `"IR"` - `"IQ"` - `"JP"` - `"JO"` - `"KZ"` - `"KW"` - `"LA"` - `"LB"` - `"MY"` - `"MV"` - `"MN"` - `"MM"` - `"NP"` - `"OM"` - `"PK"` - `"PH"` - `"QA"` - `"SA"` - `"SG"` - `"KR"` - `"LK"` - `"SY"` - `"TW"` - `"TH"` - `"TR"` - `"AE"` - `"VN"` - `"YE"` - `"AR"` - `"BO"` - `"BR"` - `"CL"` - `"CO"` - `"EC"` - `"GY"` - `"PY"` - `"PE"` - `"SR"` - `"UY"` - `"VE"` - **ownerWebsiteId:** `string` - **ownerWebsiteUrl:** `string` - **oxyJobId:** `number` - **promptId:** `string` - **promptText:** `string` - **provider:** `"BRIGHT_DATA" OR "OXY"` - `"BRIGHT_DATA"` - `"OXY"` - **status:** `"PENDING_BRIGHTDATA" OR "BRIGHTDATA_PROCESSING" OR "OXY_PROCESSING" OR 3 more` - `"PENDING_BRIGHTDATA"` - `"BRIGHTDATA_PROCESSING"` - `"OXY_PROCESSING"` - `"PROCESSING_ANSWER"` - `"POST_PROCESSING"` - `"COMPLETED"` - **triggerDate:** `string` - **websiteTopicId:** `string` ## Get Topics **post** `/api/beta/topics` Returns metrics for all the topics by website ID ### Returns - **archived:** `boolean` - **averageRanking:** `object` - **average:** `number` - **dataFormat:** `"NUMBER" OR "PERCENTAGE" OR "CURRENCY" OR 2 more` - `"NUMBER"` - `"PERCENTAGE"` - `"CURRENCY"` - `"TEXT"` - `"SCORE"` - **dates:** `array of string` - **daysSpan:** `number` - **delta:** `number` - **displayName:** `string` - **fromDate:** `string` - **language:** `"ENGLISH" OR "SPANISH" OR "PORTUGUESE" OR 9 more` - `"ENGLISH"` - `"SPANISH"` - `"PORTUGUESE"` - `"HEBREW"` - `"GERMAN"` - `"ITALIAN"` - `"FRENCH"` - `"MANDARIN"` - `"HINDI"` - `"ARABIC"` - `"JAPANESE"` - `"RUSSIAN"` - **locale:** `"GLOBAL" OR "ISRAEL" OR "EU" OR 97 more` - `"GLOBAL"` - `"ISRAEL"` - `"EU"` - `"UK"` - `"US"` - `"IL"` - `"AL"` - `"AZ"` - `"KG"` - `"BA"` - `"UZ"` - `"BI"` - `"XK"` - `"SM"` - `"DE"` - `"AT"` - `"CH"` - `"IE"` - `"IM"` - `"FR"` - `"ES"` - `"NL"` - `"IT"` - `"PT"` - `"BE"` - `"AD"` - `"MT"` - `"MC"` - `"MA"` - `"LU"` - `"TN"` - `"DZ"` - `"GI"` - `"LI"` - `"SE"` - `"DK"` - `"FI"` - `"NO"` - `"AX"` - `"IS"` - `"GG"` - `"JE"` - `"GL"` - `"VA"` - `"FX"` - `"FO"` - `"AF"` - `"AM"` - `"AU"` - `"BH"` - `"BD"` - `"BT"` - `"BN"` - `"KH"` - `"CN"` - `"CY"` - `"GE"` - `"HK"` - `"IN"` - `"ID"` - `"IR"` - `"IQ"` - `"JP"` - `"JO"` - `"KZ"` - `"KW"` - `"LA"` - `"LB"` - `"MY"` - `"MV"` - `"MN"` - `"MM"` - `"NP"` - `"OM"` - `"PK"` - `"PH"` - `"QA"` - `"SA"` - `"SG"` - `"KR"` - `"LK"` - `"SY"` - `"TW"` - `"TH"` - `"TR"` - `"AE"` - `"VN"` - `"YE"` - `"AR"` - `"BO"` - `"BR"` - `"CL"` - `"CO"` - `"EC"` - `"GY"` - `"PY"` - `"PE"` - `"SR"` - `"UY"` - `"VE"` - **median:** `number` - **metricName:** `string` - **series:** `array of object` - **date:** `string` - **value:** `number` - **toDate:** `string` - **value:** `number` - **mentionRate:** `object` - **average:** `number` - **dataFormat:** `"NUMBER" OR "PERCENTAGE" OR "CURRENCY" OR 2 more` - `"NUMBER"` - `"PERCENTAGE"` - `"CURRENCY"` - `"TEXT"` - `"SCORE"` - **dates:** `array of string` - **daysSpan:** `number` - **delta:** `number` - **displayName:** `string` - **fromDate:** `string` - **language:** `"ENGLISH" OR "SPANISH" OR "PORTUGUESE" OR 9 more` - `"ENGLISH"` - `"SPANISH"` - `"PORTUGUESE"` - `"HEBREW"` - `"GERMAN"` - `"ITALIAN"` - `"FRENCH"` - `"MANDARIN"` - `"HINDI"` - `"ARABIC"` - `"JAPANESE"` - `"RUSSIAN"` - **locale:** `"GLOBAL" OR "ISRAEL" OR "EU" OR 97 more` - `"GLOBAL"` - `"ISRAEL"` - `"EU"` - `"UK"` - `"US"` - `"IL"` - `"AL"` - `"AZ"` - `"KG"` - `"BA"` - `"UZ"` - `"BI"` - `"XK"` - `"SM"` - `"DE"` - `"AT"` - `"CH"` - `"IE"` - `"IM"` - `"FR"` - `"ES"` - `"NL"` - `"IT"` - `"PT"` - `"BE"` - `"AD"` - `"MT"` - `"MC"` - `"MA"` - `"LU"` - `"TN"` - `"DZ"` - `"GI"` - `"LI"` - `"SE"` - `"DK"` - `"FI"` - `"NO"` - `"AX"` - `"IS"` - `"GG"` - `"JE"` - `"GL"` - `"VA"` - `"FX"` - `"FO"` - `"AF"` - `"AM"` - `"AU"` - `"BH"` - `"BD"` - `"BT"` - `"BN"` - `"KH"` - `"CN"` - `"CY"` - `"GE"` - `"HK"` - `"IN"` - `"ID"` - `"IR"` - `"IQ"` - `"JP"` - `"JO"` - `"KZ"` - `"KW"` - `"LA"` - `"LB"` - `"MY"` - `"MV"` - `"MN"` - `"MM"` - `"NP"` - `"OM"` - `"PK"` - `"PH"` - `"QA"` - `"SA"` - `"SG"` - `"KR"` - `"LK"` - `"SY"` - `"TW"` - `"TH"` - `"TR"` - `"AE"` - `"VN"` - `"YE"` - `"AR"` - `"BO"` - `"BR"` - `"CL"` - `"CO"` - `"EC"` - `"GY"` - `"PY"` - `"PE"` - `"SR"` - `"UY"` - `"VE"` - **median:** `number` - **metricName:** `string` - **series:** `array of object` - **date:** `string` - **value:** `number` - **toDate:** `string` - **value:** `number` - **promptsCount:** `number` - **roi:** `number` - **searchVolume:** `number` - **shareOfVoice:** `object` - **average:** `number` - **dataFormat:** `"NUMBER" OR "PERCENTAGE" OR "CURRENCY" OR 2 more` - `"NUMBER"` - `"PERCENTAGE"` - `"CURRENCY"` - `"TEXT"` - `"SCORE"` - **dates:** `array of string` - **daysSpan:** `number` - **delta:** `number` - **displayName:** `string` - **fromDate:** `string` - **language:** `"ENGLISH" OR "SPANISH" OR "PORTUGUESE" OR 9 more` - `"ENGLISH"` - `"SPANISH"` - `"PORTUGUESE"` - `"HEBREW"` - `"GERMAN"` - `"ITALIAN"` - `"FRENCH"` - `"MANDARIN"` - `"HINDI"` - `"ARABIC"` - `"JAPANESE"` - `"RUSSIAN"` - **locale:** `"GLOBAL" OR "ISRAEL" OR "EU" OR 97 more` - `"GLOBAL"` - `"ISRAEL"` - `"EU"` - `"UK"` - `"US"` - `"IL"` - `"AL"` - `"AZ"` - `"KG"` - `"BA"` - `"UZ"` - `"BI"` - `"XK"` - `"SM"` - `"DE"` - `"AT"` - `"CH"` - `"IE"` - `"IM"` - `"FR"` - `"ES"` - `"NL"` - `"IT"` - `"PT"` - `"BE"` - `"AD"` - `"MT"` - `"MC"` - `"MA"` - `"LU"` - `"TN"` - `"DZ"` - `"GI"` - `"LI"` - `"SE"` - `"DK"` - `"FI"` - `"NO"` - `"AX"` - `"IS"` - `"GG"` - `"JE"` - `"GL"` - `"VA"` - `"FX"` - `"FO"` - `"AF"` - `"AM"` - `"AU"` - `"BH"` - `"BD"` - `"BT"` - `"BN"` - `"KH"` - `"CN"` - `"CY"` - `"GE"` - `"HK"` - `"IN"` - `"ID"` - `"IR"` - `"IQ"` - `"JP"` - `"JO"` - `"KZ"` - `"KW"` - `"LA"` - `"LB"` - `"MY"` - `"MV"` - `"MN"` - `"MM"` - `"NP"` - `"OM"` - `"PK"` - `"PH"` - `"QA"` - `"SA"` - `"SG"` - `"KR"` - `"LK"` - `"SY"` - `"TW"` - `"TH"` - `"TR"` - `"AE"` - `"VN"` - `"YE"` - `"AR"` - `"BO"` - `"BR"` - `"CL"` - `"CO"` - `"EC"` - `"GY"` - `"PY"` - `"PE"` - `"SR"` - `"UY"` - `"VE"` - **median:** `number` - **metricName:** `string` - **series:** `array of object` - **date:** `string` - **value:** `number` - **toDate:** `string` - **value:** `number` - **started:** `boolean` - **topic:** `object` - **id:** `string` - **archived:** `boolean` - **language:** `"ENGLISH" OR "SPANISH" OR "PORTUGUESE" OR 9 more` - `"ENGLISH"` - `"SPANISH"` - `"PORTUGUESE"` - `"HEBREW"` - `"GERMAN"` - `"ITALIAN"` - `"FRENCH"` - `"MANDARIN"` - `"HINDI"` - `"ARABIC"` - `"JAPANESE"` - `"RUSSIAN"` - **lastRun:** `string` - **llmProvider:** `string` - **locale:** `"GLOBAL" OR "ISRAEL" OR "EU" OR 97 more` - `"GLOBAL"` - `"ISRAEL"` - `"EU"` - `"UK"` - `"US"` - `"IL"` - `"AL"` - `"AZ"` - `"KG"` - `"BA"` - `"UZ"` - `"BI"` - `"XK"` - `"SM"` - `"DE"` - `"AT"` - `"CH"` - `"IE"` - `"IM"` - `"FR"` - `"ES"` - `"NL"` - `"IT"` - `"PT"` - `"BE"` - `"AD"` - `"MT"` - `"MC"` - `"MA"` - `"LU"` - `"TN"` - `"DZ"` - `"GI"` - `"LI"` - `"SE"` - `"DK"` - `"FI"` - `"NO"` - `"AX"` - `"IS"` - `"GG"` - `"JE"` - `"GL"` - `"VA"` - `"FX"` - `"FO"` - `"AF"` - `"AM"` - `"AU"` - `"BH"` - `"BD"` - `"BT"` - `"BN"` - `"KH"` - `"CN"` - `"CY"` - `"GE"` - `"HK"` - `"IN"` - `"ID"` - `"IR"` - `"IQ"` - `"JP"` - `"JO"` - `"KZ"` - `"KW"` - `"LA"` - `"LB"` - `"MY"` - `"MV"` - `"MN"` - `"MM"` - `"NP"` - `"OM"` - `"PK"` - `"PH"` - `"QA"` - `"SA"` - `"SG"` - `"KR"` - `"LK"` - `"SY"` - `"TW"` - `"TH"` - `"TR"` - `"AE"` - `"VN"` - `"YE"` - `"AR"` - `"BO"` - `"BR"` - `"CL"` - `"CO"` - `"EC"` - `"GY"` - `"PY"` - `"PE"` - `"SR"` - `"UY"` - `"VE"` - **prompts:** `array of object` - **id:** `string` - **language:** `"ENGLISH" OR "SPANISH" OR "PORTUGUESE" OR 9 more` - `"ENGLISH"` - `"SPANISH"` - `"PORTUGUESE"` - `"HEBREW"` - `"GERMAN"` - `"ITALIAN"` - `"FRENCH"` - `"MANDARIN"` - `"HINDI"` - `"ARABIC"` - `"JAPANESE"` - `"RUSSIAN"` - **text:** `string` - **seoKeywordIndex:** `number` - **tags:** `array of object` - **colorHex:** `string` - **name:** `string` - **websiteTopicId:** `string` - **id:** `string` - **topicIds:** `array of string` - **text:** `string` - **websiteId:** `string`