Learn how to use the endpoints we have to generate the content you'd like.
We have a variety endpoints you can call to retrieve text-based insights into your data. Here's how to know which endpoints to call.
| Single Asset, Single Metric | Single Asset, Multi Metric | Single Asset Class, Single Metric | Game Routes | |
|---|---|---|---|---|
| When to Use | If you are collecting a single metric on a recurring basis about a given thing (asset). | A table with multiple metrics for a given asset. | A table with multiple asset IDs mapped to a single asset class, reporting a metric tracked over time. | When documenting events from a game, like a sporting match. |
| Examples | Temperature over time for a given city Points per game for a given athlete * Closing share price per day of a given stock | Temperature, humidity level, and wind speed over time in a given city Points, rebounds, and assists over a set of games for a single basketball player * Closing share price, number of shares traded at each time interval, for a given stock | Temperature on a given day in multiple cities in a single nation Points per game for multiple athletes on a given team * Closing share price on a given day for multiple stocks in a single sector | The final score of a game The time, place, and participants of a game |
| Required Columns In Your Table | asset_id, time, name, value | asset_id, time, name, and "metric columns". The names of the metric columns will be used in the generated text. | asset_id, name, value, asset_class | Varies |
| Compatible Endpoints | Describe trend Report metric Report metric (no ID) Report average Change over time Change over time (random interval) Change over time (random interval, low good) Two sigma change | Strongest trend Latest best rank * Latest lowest rank | * Top three movers in class | Report game Report final score |