## 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)
```