Get a product

GET

projects

{projectId}

products

{productKey}

curl

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

import os
import requests

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

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

{
  "product_key": "<string>",
  "title": "<string>",
  "yours": true,
  "visibility": {
    "value": 123,
    "unit": "percent",
    "band": 123,
    "n": 0,
    "delta": 123,
    "within_noise": true,
    "low_sample": true,
    "state": "measured",
    "note": "<string>"
  },
  "win_rate": {
    "value": 123,
    "unit": "percent",
    "band": 123,
    "n": 0,
    "delta": 123,
    "within_noise": true,
    "low_sample": true,
    "state": "measured",
    "note": "<string>"
  },
  "position": {
    "value": 123,
    "unit": "percent",
    "band": 123,
    "n": 0,
    "delta": 123,
    "within_noise": true,
    "low_sample": true,
    "state": "measured",
    "note": "<string>"
  },
  "appearances": 0,
  "price": {
    "amount": "<string>",
    "currency": "<string>"
  },
  "stores": [
    {
      "domain": "<string>",
      "cards": 0,
      "share": 123
    }
  ],
  "trend": [
    {
      "date": "<string>",
      "visibility": {
        "value": 123,
        "unit": "percent",
        "band": 123,
        "n": 0,
        "delta": 123,
        "within_noise": true,
        "low_sample": true,
        "state": "measured",
        "note": "<string>"
      }
    }
  ],
  "prompts": {
    "shown": [
      {
        "prompt_id": "<string>",
        "text": "<string>",
        "appearances": 0,
        "shopping_answers": 0,
        "visibility": {
          "value": 123,
          "unit": "percent",
          "band": 123,
          "n": 0,
          "delta": 123,
          "within_noise": true,
          "low_sample": true,
          "state": "measured",
          "note": "<string>"
        }
      }
    ],
    "not_shown": [
      {
        "prompt_id": "<string>",
        "text": "<string>",
        "shopping_answers": 0
      }
    ]
  },
  "alongside": [
    {
      "product_key": "<string>",
      "title": "<string>",
      "answers": 0
    }
  ],
  "prices": [
    {
      "date": "<string>",
      "amount": "<string>",
      "currency": "<string>"
    }
  ]
}

{
  "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

productKey

string

required

Query Parameters

window

enum<string>

Available options:

7d,

30d,

90d,

180d,

365d,

custom

from

string

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

string

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

segments

string

engines

string

Response

product_key

string

required

title

string

required

yours

boolean

required

visibility

object | null

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

win_rate

object | null

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

position

object | null

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

appearances

integer

required

Required range: -9007199254740991 <= x <= 9007199254740991

price

object | null

required

Show child attributes

stores

object[]

required

Show child attributes

trend

object[]

required

Show child attributes

prompts

object

required

Show child attributes

alongside

object[]

required

Show child attributes

prices

object[]

required

Show child attributes

⌘I

curl

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

import os
import requests

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

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

{
  "product_key": "<string>",
  "title": "<string>",
  "yours": true,
  "visibility": {
    "value": 123,
    "unit": "percent",
    "band": 123,
    "n": 0,
    "delta": 123,
    "within_noise": true,
    "low_sample": true,
    "state": "measured",
    "note": "<string>"
  },
  "win_rate": {
    "value": 123,
    "unit": "percent",
    "band": 123,
    "n": 0,
    "delta": 123,
    "within_noise": true,
    "low_sample": true,
    "state": "measured",
    "note": "<string>"
  },
  "position": {
    "value": 123,
    "unit": "percent",
    "band": 123,
    "n": 0,
    "delta": 123,
    "within_noise": true,
    "low_sample": true,
    "state": "measured",
    "note": "<string>"
  },
  "appearances": 0,
  "price": {
    "amount": "<string>",
    "currency": "<string>"
  },
  "stores": [
    {
      "domain": "<string>",
      "cards": 0,
      "share": 123
    }
  ],
  "trend": [
    {
      "date": "<string>",
      "visibility": {
        "value": 123,
        "unit": "percent",
        "band": 123,
        "n": 0,
        "delta": 123,
        "within_noise": true,
        "low_sample": true,
        "state": "measured",
        "note": "<string>"
      }
    }
  ],
  "prompts": {
    "shown": [
      {
        "prompt_id": "<string>",
        "text": "<string>",
        "appearances": 0,
        "shopping_answers": 0,
        "visibility": {
          "value": 123,
          "unit": "percent",
          "band": 123,
          "n": 0,
          "delta": 123,
          "within_noise": true,
          "low_sample": true,
          "state": "measured",
          "note": "<string>"
        }
      }
    ],
    "not_shown": [
      {
        "prompt_id": "<string>",
        "text": "<string>",
        "shopping_answers": 0
      }
    ]
  },
  "alongside": [
    {
      "product_key": "<string>",
      "title": "<string>",
      "answers": 0
    }
  ],
  "prices": [
    {
      "date": "<string>",
      "amount": "<string>",
      "currency": "<string>"
    }
  ]
}

{
  "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

Authorizations

Path Parameters

Query Parameters

Response