Get one experiment

GET

projects

{projectId}

experiments

{experimentId}

curl

curl "https://api.citino.ai/v1/projects/{projectId}/experiments/{experimentId}" \
  -H "Authorization: Bearer $CITINO_API_KEY"

import os
import requests

res = requests.get(
    "https://api.citino.ai/v1/projects/{projectId}/experiments/{experimentId}",
    headers={"Authorization": f"Bearer {os.environ['CITINO_API_KEY']}"},
)
print(res.json())

const res = await fetch("https://api.citino.ai/v1/projects/{projectId}/experiments/{experimentId}", {
  headers: {
    Authorization: `Bearer ${process.env.CITINO_API_KEY}`,
  },
});
console.log(await res.json());

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "title": "<string>",
  "url": "<string>",
  "published_on": "<string>",
  "first_retrieved_on": "<string>",
  "read_back_note": "<string>",
  "segment_id": "<string>",
  "prompts": 0,
  "own_before": {
    "value": 123,
    "unit": "percent",
    "band": 123,
    "n": 0,
    "delta": 123,
    "within_noise": true,
    "low_sample": true,
    "state": "measured",
    "note": "<string>"
  },
  "own_after": {
    "value": 123,
    "unit": "percent",
    "band": 123,
    "n": 0,
    "delta": 123,
    "within_noise": true,
    "low_sample": true,
    "state": "measured",
    "note": "<string>"
  },
  "own_change_points": 123,
  "baseline_change_points": 123,
  "net_effect": {
    "value": 123,
    "unit": "percent",
    "band": 123,
    "n": 0,
    "delta": 123,
    "within_noise": true,
    "low_sample": true,
    "state": "measured",
    "note": "<string>"
  },
  "verdict": "measuring",
  "next_read_on": "<string>",
  "verdict_line": "<string>",
  "inconclusive_reason": "<string>",
  "mde": 123,
  "windows": {
    "before": {
      "from": "<string>",
      "to": "<string>"
    },
    "after": {
      "from": "<string>",
      "to": "<string>"
    },
    "gap_days": 0
  },
  "after_days": 0,
  "min_after_days": 0,
  "cohort": [
    "<string>"
  ],
  "read_number": 0,
  "note": "<string>",
  "closed_at": "<string>",
  "by_engine": [
    {
      "engine": "<string>",
      "before": {
        "value": 123,
        "unit": "percent",
        "band": 123,
        "n": 0,
        "delta": 123,
        "within_noise": true,
        "low_sample": true,
        "state": "measured",
        "note": "<string>"
      },
      "after": {
        "value": 123,
        "unit": "percent",
        "band": 123,
        "n": 0,
        "delta": 123,
        "within_noise": true,
        "low_sample": true,
        "state": "measured",
        "note": "<string>"
      }
    }
  ],
  "drift": [
    {
      "occurred_on": "<string>",
      "engine": "<string>",
      "severity": "<string>",
      "brands_moved": 0,
      "brands_named": 0,
      "window": "before"
    }
  ]
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "detail": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "detail": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "detail": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "detail": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "detail": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "detail": {}
  }
}

Authorizations

Authorization

string

header

required

An API key from Workspace settings → API keys, sent as Authorization: Bearer <key>.

Path Parameters

projectId

string

required

experimentId

string

required

Response

string<uuid>

required

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

title

string

required

url

string | null

required

published_on

string

required

Pattern: ^\d{4}-\d{2}-\d{2}$

first_retrieved_on

string | null

required

Pattern: ^\d{4}-\d{2}-\d{2}$

read_back_note

string

required

segment_id

string | null

required

prompts

integer

required

Required range: -9007199254740991 <= x <= 9007199254740991

own_before

object

required

A measured number with its uncertainty. value is null with n = 0 (no answers yet); within_noise true means a delta is not a move.

Show child attributes

own_after

object

required

A measured number with its uncertainty. value is null with n = 0 (no answers yet); within_noise true means a delta is not a move.

Show child attributes

own_change_points

number | null

required

baseline_change_points

number | null

required

net_effect

object

required

Your change less the market's. No value until the after window is long enough.

Show child attributes

verdict

enum<string>

required

Available options:

measuring,

confirmed,

inconclusive,

negative

next_read_on

string

required

Pattern: ^\d{4}-\d{2}-\d{2}$

verdict_line

string

required

inconclusive_reason

string | null

required

mde

number | null

required

The smallest effect this segment can show, in points.

windows

object

required

Show child attributes

after_days

integer | null

required

Required range: -9007199254740991 <= x <= 9007199254740991

min_after_days

integer

required

Required range: -9007199254740991 <= x <= 9007199254740991

cohort

string[]

required

read_number

integer

required

Required range: -9007199254740991 <= x <= 9007199254740991

note

string | null

required

closed_at

string | null

required

by_engine

object[]

required

Show child attributes

drift

object[]

required

Market-wide moves inside the windows: labelled, never removed from the figures.

Show child attributes

⌘I

curl

curl "https://api.citino.ai/v1/projects/{projectId}/experiments/{experimentId}" \
  -H "Authorization: Bearer $CITINO_API_KEY"

import os
import requests

res = requests.get(
    "https://api.citino.ai/v1/projects/{projectId}/experiments/{experimentId}",
    headers={"Authorization": f"Bearer {os.environ['CITINO_API_KEY']}"},
)
print(res.json())

const res = await fetch("https://api.citino.ai/v1/projects/{projectId}/experiments/{experimentId}", {
  headers: {
    Authorization: `Bearer ${process.env.CITINO_API_KEY}`,
  },
});
console.log(await res.json());

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "title": "<string>",
  "url": "<string>",
  "published_on": "<string>",
  "first_retrieved_on": "<string>",
  "read_back_note": "<string>",
  "segment_id": "<string>",
  "prompts": 0,
  "own_before": {
    "value": 123,
    "unit": "percent",
    "band": 123,
    "n": 0,
    "delta": 123,
    "within_noise": true,
    "low_sample": true,
    "state": "measured",
    "note": "<string>"
  },
  "own_after": {
    "value": 123,
    "unit": "percent",
    "band": 123,
    "n": 0,
    "delta": 123,
    "within_noise": true,
    "low_sample": true,
    "state": "measured",
    "note": "<string>"
  },
  "own_change_points": 123,
  "baseline_change_points": 123,
  "net_effect": {
    "value": 123,
    "unit": "percent",
    "band": 123,
    "n": 0,
    "delta": 123,
    "within_noise": true,
    "low_sample": true,
    "state": "measured",
    "note": "<string>"
  },
  "verdict": "measuring",
  "next_read_on": "<string>",
  "verdict_line": "<string>",
  "inconclusive_reason": "<string>",
  "mde": 123,
  "windows": {
    "before": {
      "from": "<string>",
      "to": "<string>"
    },
    "after": {
      "from": "<string>",
      "to": "<string>"
    },
    "gap_days": 0
  },
  "after_days": 0,
  "min_after_days": 0,
  "cohort": [
    "<string>"
  ],
  "read_number": 0,
  "note": "<string>",
  "closed_at": "<string>",
  "by_engine": [
    {
      "engine": "<string>",
      "before": {
        "value": 123,
        "unit": "percent",
        "band": 123,
        "n": 0,
        "delta": 123,
        "within_noise": true,
        "low_sample": true,
        "state": "measured",
        "note": "<string>"
      },
      "after": {
        "value": 123,
        "unit": "percent",
        "band": 123,
        "n": 0,
        "delta": 123,
        "within_noise": true,
        "low_sample": true,
        "state": "measured",
        "note": "<string>"
      }
    }
  ],
  "drift": [
    {
      "occurred_on": "<string>",
      "engine": "<string>",
      "severity": "<string>",
      "brands_moved": 0,
      "brands_named": 0,
      "window": "before"
    }
  ]
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "detail": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "detail": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "detail": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "detail": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "detail": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "detail": {}
  }
}

Overview

Reference

Get one experiment

Authorizations

Path Parameters

Response