Skip to main content

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:

  1. type=first_exposures - Provides a link to download your company's full set of "first exposures" across feature gates and experiments.
  2. 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 NameDescription
copmany_id
unit_idRefers to the unit identifier used in the experiment
exposure_typeStatsig Product used: "check_gate" for Feature Gates, and "get_experiment" for Experiments
nameThe name of the gate/experiment
ruleFor gates, this refers to the rule name
experiment_groupThe group the user was assigned to
first_exposure_utcThe UTC timestamp when the user was first assigned to the experiment
first_exposure_pst_dateThe date in PST when the user was first assigned to the experiment
as_of_pst_dateThe date this data was generated
percentGroup's rollout percent. This is the rule-level pass-rate, or the experiment's group size
rolloutRollout version number
user_dimensionsJSON-formatted key-value pairs describing the user's attributes at the time of first exposure

Report Schema - type = pulse_daily

Column NameDescription
copmany_idSTRING, the id of the company
nameSTRING, the name of the gate/experiment
ruleSTRING, for gates, this refers to the rule name
experiment_groupSTRING, the group the user was assigned to
pst_dateDATE, the 24hr window the the data refers to. All dates are anchored from 12:00a -> 11:59p PST.
metric_typeSTRING, the type of the metric, e.g. ratio
metric_nameSTRING, the name of the metric
metric_dimensionSTRING, the name of the metric dimension. '!statsig_topline' is the overall metric with no slicing
unitsBIGINT, the number of users included in this metric
participating_unitsBIGINT, the number of users participated in this metric
meanDOUBLE, the average value of this metric across units (or participating units when applicable)
totalDOUBLE, the sum of this metric across units
stddevDOUBLE, the standard deviation of this metric across units
stderrDOUBLE, the standard error of this metric across units
varpopDOUBLE, the varpop of this metric
  • New columns may be added in the future.