v1/get_daily_report
Authorization
All requests must include the Server-Side Secret Key field in the header. This can can be created in the Project Settings on console.statsig.com/api_keys. This feature requires Pro or Enterprise Tier.
info
This is available for Enterprise contracts and needs to be enabled for you, once. Please reach out to our support team, your sales contact, or via our slack channel if you want this enabled.
Responses
All responses will contain a url field and a date field.
- url is the URL containing the daily report.
- date is the date of the currentlyavailable report.
Get Daily Reports
You can export your Pulse data via the console or using this API. This API supports two types of daily reports:
- type=first_exposures - Provides a link to download your company's full set of "first exposures" across feature gates and experiments.
- type=pulse_daily - Provides a link to download your company's daily experimental results. This data is a single day's results and a full experimental analysis requires the entire duration of the experiment.
This feature is available to Pro and Enterprise tier customers.
curl \
--header "statsig-api-key: <YOUR-SERVER-SECRET-KEY>" \
--header "Content-Type: application/json" \
--request POST \
--data '{"type": "first_exposures" }' \
"https://api.statsig.com/v1/get_daily_report"
Reponse JSON :
{
"url": <url to download CSV for the specified type>,
"date": <date in PST of data>,
}
Report Schema - type = first_exposures
Column Name | Description |
---|---|
copmany_id | |
unit_id | Refers to the unit identifier used in the experiment |
exposure_type | Statsig Product used: "check_gate" for Feature Gates, and "get_experiment" for Experiments |
name | The name of the gate/experiment |
rule | For gates, this refers to the rule name |
experiment_group | The group the user was assigned to |
first_exposure_utc | The UTC timestamp when the user was first assigned to the experiment |
first_exposure_pst_date | The date in PST when the user was first assigned to the experiment |
as_of_pst_date | The date this data was generated |
percent | Group's rollout percent. This is the rule-level pass-rate, or the experiment's group size |
rollout | Rollout version number |
user_dimensions | JSON-formatted key-value pairs describing the user's attributes at the time of first exposure |
Report Schema - type = pulse_daily
Column Name | Description |
---|---|
copmany_id | STRING, the id of the company |
name | STRING, the name of the gate/experiment |
rule | STRING, for gates, this refers to the rule name |
experiment_group | STRING, the group the user was assigned to |
pst_date | DATE, the 24hr window the the data refers to. All dates are anchored from 12:00a -> 11:59p PST. |
metric_type | STRING, the type of the metric, e.g. ratio |
metric_name | STRING, the name of the metric |
metric_dimension | STRING, the name of the metric dimension. '!statsig_topline' is the overall metric with no slicing |
units | BIGINT, the number of users included in this metric |
participating_units | BIGINT, the number of users participated in this metric |
mean | DOUBLE, the average value of this metric across units (or participating units when applicable) |
total | DOUBLE, the sum of this metric across units |
stddev | DOUBLE, the standard deviation of this metric across units |
stderr | DOUBLE, the standard error of this metric across units |
varpop | DOUBLE, the varpop of this metric |
- New columns may be added in the future.