# Client ## Get Aggregated Prompts `get_aggregated_prompts(ClientGetAggregatedPromptsParams**kwargs) -> GetAggregatedPromptsResponse` **post** `/api/beta/prompts` Returns metrics for all prompts with frequency over time topic ID ### Parameters - **website\_topic\_id:** `str` - **from\_date:** `int` - **llm\_provider:** `str` - **tag\_ids:** `List[str]` - **to\_date:** `int` ### Returns - **GetAggregatedPromptsResponse:** `List[GetAggregatedPromptsResponseItem]` - **answer\_text:** `Optional[str]` - **important\_terms:** `Optional[List[str]]` - **invocations:** `Optional[int]` - **latest\_run\_data:** `Optional[datetime]` - **mention\_frequency:** `Optional[GetAggregatedPromptsResponseItemMentionFrequency]` - **average:** `Optional[float]` - **data\_format:** `Optional[Literal["NUMBER", "PERCENTAGE", "CURRENCY", 2 more]]` - `"NUMBER"` - `"PERCENTAGE"` - `"CURRENCY"` - `"TEXT"` - `"SCORE"` - **dates:** `Optional[List[datetime]]` - **days\_span:** `Optional[int]` - **delta:** `Optional[float]` - **display\_name:** `Optional[str]` - **from\_date:** `Optional[datetime]` - **language:** `Optional[Literal["ENGLISH", "SPANISH", "PORTUGUESE", 9 more]]` - `"ENGLISH"` - `"SPANISH"` - `"PORTUGUESE"` - `"HEBREW"` - `"GERMAN"` - `"ITALIAN"` - `"FRENCH"` - `"MANDARIN"` - `"HINDI"` - `"ARABIC"` - `"JAPANESE"` - `"RUSSIAN"` - **locale:** `Optional[Literal["GLOBAL", "ISRAEL", "EU", 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:** `Optional[float]` - **metric\_name:** `Optional[str]` - **series:** `Optional[List[GetAggregatedPromptsResponseItemMentionFrequencySery]]` - **date:** `datetime` - **value:** `float` - **to\_date:** `Optional[datetime]` - **value:** `Optional[float]` - **negative\_sentiments:** `Optional[List[Dict[str, str]]]` - **positive\_sentiments:** `Optional[List[Dict[str, str]]]` - **prompt:** `Optional[str]` - **prompt\_analysis\_id:** `Optional[str]` - **prompt\_id:** `Optional[str]` - **prompts\_count:** `Optional[int]` - **ranking:** `Optional[float]` - **seo\_metrics:** `Optional[GetAggregatedPromptsResponseItemSeoMetrics]` - **cpc:** `Optional[float]` - **search\_volume:** `Optional[int]` - **share\_of\_voice:** `Optional[float]` - **sources:** `Optional[List[str]]` ### Example ```python from anvil import Anvil client = Anvil( api_key="My API Key", ) response = client.get_aggregated_prompts( website_topic_id="websiteTopicId", from_date=0, llm_provider="llmProvider", tag_ids=["string"], to_date=0, ) print(response) ``` ## Get Metadata `get_metadata() -> GetMetadataResponse` **get** `/api/beta/metadata` Returns all metadata by website ID ### Returns - **GetMetadataResponse:** `List[GetMetadataResponseItem]` - **id:** `Optional[str]` - **llm\_provider:** `Optional[str]` - **prompts:** `Optional[List[GetMetadataResponseItemPrompt]]` - **id:** `Optional[str]` - **language:** `Optional[Literal["ENGLISH", "SPANISH", "PORTUGUESE", 9 more]]` - `"ENGLISH"` - `"SPANISH"` - `"PORTUGUESE"` - `"HEBREW"` - `"GERMAN"` - `"ITALIAN"` - `"FRENCH"` - `"MANDARIN"` - `"HINDI"` - `"ARABIC"` - `"JAPANESE"` - `"RUSSIAN"` - **text:** `Optional[str]` - **text:** `Optional[str]` ### Example ```python from anvil import Anvil client = Anvil( api_key="My API Key", ) response = client.get_metadata() print(response) ``` ## Get Prompt `get_prompt(ClientGetPromptParams**kwargs) -> GetPromptResponse` **get** `/api/beta/prompts` Returns all related metrics data by prompt ID ### Parameters - **prompt\_id:** `str` ### Returns - **GetPromptResponse:** `List[GetPromptResponseItem]` - **id:** `Optional[str]` - **answer\_text:** `Optional[str]` - **bright\_data\_prompt\_index:** `Optional[int]` - **complete\_post\_process:** `Optional[bool]` - **created:** `Optional[datetime]` - **data:** `Optional[GetPromptResponseItemData]` - **important\_terms:** `Optional[List[str]]` - **mentions:** `Optional[Dict[str, int]]` - **negative\_sentiment:** `Optional[List[Dict[str, str]]]` - **positive\_sentiments:** `Optional[List[Dict[str, str]]]` - **ranking:** `Optional[Dict[str, int]]` - **sentiment\_score:** `Optional[Dict[str, int]]` - **sources:** `Optional[List[str]]` - **language:** `Optional[Literal["ENGLISH", "SPANISH", "PORTUGUESE", 9 more]]` - `"ENGLISH"` - `"SPANISH"` - `"PORTUGUESE"` - `"HEBREW"` - `"GERMAN"` - `"ITALIAN"` - `"FRENCH"` - `"MANDARIN"` - `"HINDI"` - `"ARABIC"` - `"JAPANESE"` - `"RUSSIAN"` - **llm\_provider:** `Optional[Literal["openai/gpt-4o", "openai/gpt-4o-search-preview", "perplexity", "gemini"]]` - `"openai/gpt-4o"` - `"openai/gpt-4o-search-preview"` - `"perplexity"` - `"gemini"` - **locale:** `Optional[Literal["GLOBAL", "ISRAEL", "EU", 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"` - **owner\_website\_id:** `Optional[str]` - **owner\_website\_url:** `Optional[str]` - **oxy\_job\_id:** `Optional[int]` - **prompt\_id:** `Optional[str]` - **prompt\_text:** `Optional[str]` - **provider:** `Optional[Literal["BRIGHT_DATA", "OXY"]]` - `"BRIGHT_DATA"` - `"OXY"` - **status:** `Optional[Literal["PENDING_BRIGHTDATA", "BRIGHTDATA_PROCESSING", "OXY_PROCESSING", 3 more]]` - `"PENDING_BRIGHTDATA"` - `"BRIGHTDATA_PROCESSING"` - `"OXY_PROCESSING"` - `"PROCESSING_ANSWER"` - `"POST_PROCESSING"` - `"COMPLETED"` - **trigger\_date:** `Optional[datetime]` - **website\_topic\_id:** `Optional[str]` ### Example ```python from anvil import Anvil client = Anvil( api_key="My API Key", ) response = client.get_prompt( prompt_id="promptId", ) print(response) ``` ## Get Topics `get_topics(ClientGetTopicsParams**kwargs) -> GetTopicsResponse` **post** `/api/beta/topics` Returns metrics for all the topics by website ID ### Parameters - **from\_date:** `int` - **llm\_provider:** `str` - **tag\_ids:** `List[str]` - **to\_date:** `int` - **archive:** `bool` - **competitor\_url:** `str` ### Returns - **GetTopicsResponse:** `List[GetTopicsResponseItem]` - **archived:** `Optional[bool]` - **average\_ranking:** `Optional[GetTopicsResponseItemAverageRanking]` - **average:** `Optional[float]` - **data\_format:** `Optional[Literal["NUMBER", "PERCENTAGE", "CURRENCY", 2 more]]` - `"NUMBER"` - `"PERCENTAGE"` - `"CURRENCY"` - `"TEXT"` - `"SCORE"` - **dates:** `Optional[List[datetime]]` - **days\_span:** `Optional[int]` - **delta:** `Optional[float]` - **display\_name:** `Optional[str]` - **from\_date:** `Optional[datetime]` - **language:** `Optional[Literal["ENGLISH", "SPANISH", "PORTUGUESE", 9 more]]` - `"ENGLISH"` - `"SPANISH"` - `"PORTUGUESE"` - `"HEBREW"` - `"GERMAN"` - `"ITALIAN"` - `"FRENCH"` - `"MANDARIN"` - `"HINDI"` - `"ARABIC"` - `"JAPANESE"` - `"RUSSIAN"` - **locale:** `Optional[Literal["GLOBAL", "ISRAEL", "EU", 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:** `Optional[float]` - **metric\_name:** `Optional[str]` - **series:** `Optional[List[GetTopicsResponseItemAverageRankingSery]]` - **date:** `datetime` - **value:** `float` - **to\_date:** `Optional[datetime]` - **value:** `Optional[float]` - **mention\_rate:** `Optional[GetTopicsResponseItemMentionRate]` - **average:** `Optional[float]` - **data\_format:** `Optional[Literal["NUMBER", "PERCENTAGE", "CURRENCY", 2 more]]` - `"NUMBER"` - `"PERCENTAGE"` - `"CURRENCY"` - `"TEXT"` - `"SCORE"` - **dates:** `Optional[List[datetime]]` - **days\_span:** `Optional[int]` - **delta:** `Optional[float]` - **display\_name:** `Optional[str]` - **from\_date:** `Optional[datetime]` - **language:** `Optional[Literal["ENGLISH", "SPANISH", "PORTUGUESE", 9 more]]` - `"ENGLISH"` - `"SPANISH"` - `"PORTUGUESE"` - `"HEBREW"` - `"GERMAN"` - `"ITALIAN"` - `"FRENCH"` - `"MANDARIN"` - `"HINDI"` - `"ARABIC"` - `"JAPANESE"` - `"RUSSIAN"` - **locale:** `Optional[Literal["GLOBAL", "ISRAEL", "EU", 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:** `Optional[float]` - **metric\_name:** `Optional[str]` - **series:** `Optional[List[GetTopicsResponseItemMentionRateSery]]` - **date:** `datetime` - **value:** `float` - **to\_date:** `Optional[datetime]` - **value:** `Optional[float]` - **prompts\_count:** `Optional[int]` - **roi:** `Optional[float]` - **search\_volume:** `Optional[int]` - **share\_of\_voice:** `Optional[GetTopicsResponseItemShareOfVoice]` - **average:** `Optional[float]` - **data\_format:** `Optional[Literal["NUMBER", "PERCENTAGE", "CURRENCY", 2 more]]` - `"NUMBER"` - `"PERCENTAGE"` - `"CURRENCY"` - `"TEXT"` - `"SCORE"` - **dates:** `Optional[List[datetime]]` - **days\_span:** `Optional[int]` - **delta:** `Optional[float]` - **display\_name:** `Optional[str]` - **from\_date:** `Optional[datetime]` - **language:** `Optional[Literal["ENGLISH", "SPANISH", "PORTUGUESE", 9 more]]` - `"ENGLISH"` - `"SPANISH"` - `"PORTUGUESE"` - `"HEBREW"` - `"GERMAN"` - `"ITALIAN"` - `"FRENCH"` - `"MANDARIN"` - `"HINDI"` - `"ARABIC"` - `"JAPANESE"` - `"RUSSIAN"` - **locale:** `Optional[Literal["GLOBAL", "ISRAEL", "EU", 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:** `Optional[float]` - **metric\_name:** `Optional[str]` - **series:** `Optional[List[GetTopicsResponseItemShareOfVoiceSery]]` - **date:** `datetime` - **value:** `float` - **to\_date:** `Optional[datetime]` - **value:** `Optional[float]` - **started:** `Optional[bool]` - **topic:** `Optional[GetTopicsResponseItemTopic]` - **id:** `Optional[str]` - **archived:** `Optional[bool]` - **language:** `Optional[Literal["ENGLISH", "SPANISH", "PORTUGUESE", 9 more]]` - `"ENGLISH"` - `"SPANISH"` - `"PORTUGUESE"` - `"HEBREW"` - `"GERMAN"` - `"ITALIAN"` - `"FRENCH"` - `"MANDARIN"` - `"HINDI"` - `"ARABIC"` - `"JAPANESE"` - `"RUSSIAN"` - **last\_run:** `Optional[datetime]` - **llm\_provider:** `Optional[str]` - **locale:** `Optional[Literal["GLOBAL", "ISRAEL", "EU", 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:** `Optional[List[GetTopicsResponseItemTopicPrompt]]` - **id:** `Optional[str]` - **language:** `Optional[Literal["ENGLISH", "SPANISH", "PORTUGUESE", 9 more]]` - `"ENGLISH"` - `"SPANISH"` - `"PORTUGUESE"` - `"HEBREW"` - `"GERMAN"` - `"ITALIAN"` - `"FRENCH"` - `"MANDARIN"` - `"HINDI"` - `"ARABIC"` - `"JAPANESE"` - `"RUSSIAN"` - **text:** `Optional[str]` - **seo\_keyword\_index:** `Optional[int]` - **tags:** `Optional[List[GetTopicsResponseItemTopicTag]]` - **color\_hex:** `str` - **name:** `str` - **website\_topic\_id:** `str` - **id:** `Optional[str]` - **topic\_ids:** `Optional[List[str]]` - **text:** `Optional[str]` - **website\_id:** `Optional[str]` ### Example ```python from anvil import Anvil client = Anvil( api_key="My API Key", ) response = client.get_topics( from_date=0, llm_provider="llmProvider", tag_ids=["string"], to_date=0, ) print(response) ```