Helper Endpoints

The following endpoints are for your convenience when working with the other endpoints.

KPIs

1. GET /kpis - returns all KPIs you have configured in your app.

2. GET /kpis/[kpi-id] returns the current depvar_configurations with the latest deployments and spikes for a given KPI.

Deployments

A deployment is a specific run of a model. Each weekly update of your model will receive a new deployment ID.

1. GET /deployments - returns all deployments available in your app.

   1. dashboad_slug can be used to narrow down to a single dashboard.

2. GET /deployments/[deployments-id] returns a summary of that deployment, including:

   1. active - boolean

   2. dashboard_slug - what dashboard it’s connected to

   3. model_date - the last day included in the model

   4. spend - an array of the historical spend. You must specify that you want this using the extra_fields argument.

   5. default_budget - A default business as usual budget. You must specify that you want this using the extra_fields argument.

   6. upper_funnel_channel_labels - the names of the upper funnel channels

   7. lower_funnel_channel_labels - the names of the lower funnel channels

   8. spend_channels_labels - the names of the spend channels

   9. non_spend_channels_labels - the names of the non-spend channels

   10. contextual_variable_defaults - The names and default values for contextual variables

More information available in Swagger (must be logged in first)