ITiterable
experiments

Get experiment trends

Changed on

Get histogram time series data for each variant in a campaign experiment. Iterable picks the interval between data points based on the date range. To choose a date range, send both <code>startDateTime</code> and <code>endDateTime</code> as UTC ISO 8601 timestamps. The range must fall within the period the experiment ran and can't exceed 31 days. If you omit both, Iterable returns up to the last 31 days the experiment ran, ending one minute before the experiment ended, or before the current time if it's still <code>running</code>. If the experiment hasn't started, the response contains no data. This endpoint doesn't support journey experiments.

get/api/experiments/{experimentId}/trends

Request

  • Base URL
    https://api.iterable.com
  • Auth
    API key in header Api-Key

Path parameters

experimentIdinteger required

Experiment ID

Query parameters

startDateTimestring date-time

Start of the date range (inclusive), as a UTC ISO 8601 timestamp. Required if you send <code>endDateTime</code>.

endDateTimestring date-time

End of the date range (inclusive), as a UTC ISO 8601 timestamp. Required if you send <code>startDateTime</code>.

Response

successful operation

endDateTimestring date-time required

Inclusive series end in UTC ISO-8601

idinteger required

Experiment ID

intervalstring required

Auto-selected histogram interval label

startDateTimestring date-time required

Inclusive series start in UTC ISO-8601

status'draft' | 'ready' | 'running' | 'finished' | 'winner_found' required

Experiment status

Changes