get_entities.md•1.43 kB
<instructions>
Get the entities for specified metrics
Entities are real-world concepts in a business such as customers,
transactions, and ad campaigns. Analysis is often focused around
specific entities, such as customer churn or
annual recurring revenue modeling.
</instructions>
<examples>
<example>
Question: "I want to analyze revenue - what entities are available?"
Thinking step-by-step:
- Using list_metrics(), I find "revenue" is available
- Now I can get the entities for this metric
- The search parameter is not needed here since the user is interested in all available entities.
Parameters:
metrics=["revenue"]
search=null
</example>
<example>
Question: "Are there any customer-related entities for my sales metrics?"
Thinking step-by-step:
- Using list_metrics(), I find "total_sales" and "average_order_value" are available
- The user is interested in customer entities specifically
- I should use the search parameter to filter for entities with "customer" in the name
- This will narrow down the results to just customer-related entities
Parameters:
metrics=["total_sales", "average_order_value"]
search="customer"
</example>
</examples>
<parameters>
metrics: List of metric names
search: Optional string used to filter entities by name using partial matches (only use when absolutely necessary as some entities might be missed due to specific naming styles)
</parameters>