Get result time series for experiment

GET /experiments/{experiment}/timeseries

Get result time series for experiment. Requires the REST read token ability. The bearer token selects the Team; a supplied team_id cannot switch tenants. Additional role, entity-policy and plan requirements vary by operation.

Authentication

Use a team API key as Authorization: Bearer YOUR_API_KEY. The token ability and the user’s role must both allow this operation. See authentication.

{
  "ability": "read",
  "team": "Token-bound Team",
  "authorization": "Additional role, entity-policy and plan requirements vary by operation."
}

Parameters

Name	Location	Required	Description
`experiment`	path	Yes	The experiment ID
`start`	query	No	Start.
`end`	query	No	End.

experiment

{
  "type": "integer",
  "minimum": 1
}

start

{
  "type": "string",
  "format": "date-time"
}

end

{
  "type": "string",
  "format": "date-time"
}

Example request

curl --request GET 'https://api.example.test/api/experiments/1/timeseries' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Accept: application/json'

Examples use fictional data. Replace resource IDs and the API host with your environment’s values.

Responses

200

Array of ExperimentTimeseriesResource

Content type: application/json.

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "variation_id": {
            "type": "integer"
          },
          "name": {
            "type": "string"
          },
          "points": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "date": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date"
                },
                "visitors": {
                  "type": "integer",
                  "minimum": 0
                },
                "conversions": {
                  "type": "integer",
                  "minimum": 0
                },
                "conversion_rate": {
                  "type": [
                    "number",
                    "null"
                  ],
                  "description": "Conversion rate as a percentage, not a fraction."
                }
              },
              "required": [
                "date",
                "visitors",
                "conversions",
                "conversion_rate"
              ]
            }
          }
        },
        "required": [
          "variation_id",
          "name",
          "points"
        ]
      }
    }
  },
  "required": [
    "data"
  ]
}

{
  "data": [
    {
      "variation_id": 101,
      "name": "Checkout delivery estimate",
      "points": [
        {
          "date": null,
          "visitors": 1,
          "conversions": 1,
          "conversion_rate": null
        }
      ]
    }
  ]
}

401

Unauthenticated

Content type: application/json.

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "Error overview."
    }
  },
  "required": [
    "message"
  ]
}

{
  "message": "The request could not be completed."
}

403

Authorization error

Content type: application/json.

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "Error overview."
    }
  },
  "required": [
    "message"
  ]
}

{
  "message": "The request could not be completed."
}

404

Not found

Content type: application/json.

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "Error overview."
    }
  },
  "required": [
    "message"
  ]
}

{
  "message": "The request could not be completed."
}

422

Validation error

Content type: application/json.

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "Errors overview."
    },
    "errors": {
      "type": "object",
      "description": "A detailed description of each field that failed validation.",
      "additionalProperties": {
        "type": "array",
        "items": {
          "type": "string"
        }
      }
    }
  },
  "required": [
    "message",
    "errors"
  ]
}

{
  "message": "The request could not be completed.",
  "errors": {
    "name": [
      "The name field is required."
    ]
  }
}

429

Rate limit exceeded. Honor Retry-After before retrying.

Response headers:

{
  "Retry-After": {
    "description": "Seconds before retrying.",
    "schema": {
      "type": "integer"
    }
  }
}

Content type: application/json.

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "example": "Too Many Attempts."
    }
  },
  "required": [
    "message"
  ]
}

{
  "message": "Too Many Attempts."
}

See API conventions for error handling, rate limits, pagination, and uploads.

On this page