# Metric Plot

Compare metrics on a timeseries plot

## Parameters

| Name                  | Type                | Description                                                                                                                                                                                                                                                                                                                                                   | Is Optional |
| --------------------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| metrics               | comparison\_list    | List of input metrics/calculations to plot                                                                                                                                                                                                                                                                                                                    |             |
| filters               | filter\_list        | Filter logic on one or more columns. Can choose between a simple comparison filter or advanced filter using free text.                                                                                                                                                                                                                                        | True        |
| group\_by\_dimensions | dimension\_list     | Categorical column(s) by which to pivot the calculated metrics. Including this argument will generate a new metric calculation for each distinct value in the group by column. If this column has more than 20 distinct values, the plot will not generate.                                                                                                   | True        |
| timeseries\_options   | timeseries\_options | (Required if 'x\_axis' is a date/datetime type) A dictionary containing the start and end dates as well as the time grain which will be used to create the datespine for the x\_axis. Time grain options are ('day', 'week', 'month', 'year', 'quarter', and 'all') Example: { "start\_date": "2021-12-01", "end\_date": "2022-07-01", "time\_grain": "day" } |             |

## Example

```python
ds = rasgo.get.dataset(id)

ds2 = ds.metric_plot(
  metrics=[
    {
      "name": "Total_Sales"
      "type": "SUM",
      "source_table": "RASGO.PUBLIC.SALES",
      "target_expression": "TOTALSALES",
      "time_dimension": "BILLING_DATE",
      "time_grains": ["WEEK","MONTH","QUARTER","YEAR"],
      "secondary_calculation": {
        "type": "period_over_period",
        "comparison_strategy": "ratio",
        "interval": 7
      }
    }
  ],
  group_by_dimensions=["BUSINESS_SEGMENT"],
  timeseries_options={
    "start_date": "2021-12-01",
    "end_date": "2022-07-01",
    "time_grain": "day"
  },
  filters=[
    {
      "column_name": "BILLING_REGION",
      "operator": "="
      "comparison_value": "SOUTHWEST",
    }
  ]
)
ds2.preview()
```

## Source Code

{% embed url="<https://github.com/rasgointelligence/RasgoTransforms/blob/main/rasgotransforms/rasgotransforms/transforms/metric_plot/metric_plot.sql>" %}