Get Requests

POST

request

query

object

filter

Option 1 · object

request_response_rmt

object

latency

object

not-equals

number

equals

number

gte

number

lte

number

status

object

not-equals

number

equals

number

gte

number

lte

number

request_created_at

object

gte

string

lte

string

response_created_at

object

gte

string

lte

string

model

object

not-equals

string

equals

string

ilike

string

contains

string

not-contains

string

user_id

object

not-equals

string

equals

string

ilike

string

contains

string

not-contains

string

organization_id

object

not-equals

string

equals

string

ilike

string

contains

string

not-contains

string

node_id

object

not-equals

string

equals

string

ilike

string

contains

string

not-contains

string

job_id

object

not-equals

string

equals

string

ilike

string

contains

string

not-contains

string

threat

object

equals

boolean

request_id

object

not-equals

string

equals

string

ilike

string

contains

string

not-contains

string

prompt_tokens

object

not-equals

number

equals

number

gte

number

lte

number

completion_tokens

object

not-equals

number

equals

number

gte

number

lte

number

total_tokens

object

not-equals

number

equals

number

gte

number

lte

number

target_url

object

not-equals

string

equals

string

ilike

string

contains

string

not-contains

string

properties

object

search_properties

object

scores

object

scores_column

object

not-equals

string

equals

string

ilike

string

contains

string

not-contains

string

request_body

object

contains

string

response_body

object

contains

string

response

object

body_tokens

object

not-equals

number

equals

number

gte

number

lte

number

body_model

object

not-equals

string

equals

string

ilike

string

contains

string

not-contains

string

body_completion

object

not-equals

string

equals

string

ilike

string

contains

string

not-contains

string

status

object

not-equals

number

equals

number

gte

number

lte

number

model

object

not-equals

string

equals

string

ilike

string

contains

string

not-contains

string

request

object

prompt

object

not-equals

string

equals

string

ilike

string

contains

string

not-contains

string

created_at

object

gte

string

lte

string

user_id

object

not-equals

string

equals

string

ilike

string

contains

string

not-contains

string

auth_hash

object

not-equals

string

equals

string

ilike

string

contains

string

not-contains

string

org_id

object

not-equals

string

equals

string

ilike

string

contains

string

not-contains

string

object

not-equals

string

equals

string

ilike

string

contains

string

not-contains

string

node_id

object

not-equals

string

equals

string

ilike

string

contains

string

not-contains

string

model

object

not-equals

string

equals

string

ilike

string

contains

string

not-contains

string

modelOverride

object

not-equals

string

equals

string

ilike

string

contains

string

not-contains

string

path

object

not-equals

string

equals

string

ilike

string

contains

string

not-contains

string

prompt_id

object

not-equals

string

equals

string

ilike

string

contains

string

not-contains

string

feedback

object

not-equals

number

equals

number

gte

number

lte

number

created_at

object

gte

string

lte

string

rating

object

equals

boolean

response_id

object

not-equals

string

equals

string

ilike

string

contains

string

not-contains

string

request_response_search

object

request_body_vector

object

contains

string

response_body_vector

object

contains

string

sessions_request_response_rmt

object

total_cost

object

not-equals

number

equals

number

gte

number

lte

number

total_tokens

object

not-equals

number

equals

number

gte

number

lte

number

cache_hits

object

organization_id

object

not-equals

string

equals

string

ilike

string

contains

string

not-contains

string

request_id

object

not-equals

string

equals

string

ilike

string

contains

string

not-contains

string

latency

object

not-equals

number

equals

number

gte

number

lte

number

completion_tokens

object

not-equals

number

equals

number

gte

number

lte

number

prompt_tokens

object

not-equals

number

equals

number

gte

number

lte

number

created_at

object

gte

string

lte

string

properties

object

values

object

offset

number

limit

number

sort

object

random

boolean

created_at

enum<string>

cache_created_at

enum<string>

latency

enum<string>

last_active

enum<string>

total_tokens

enum<string>

completion_tokens

enum<string>

prompt_tokens

enum<string>

user_id

enum<string>

body_model

enum<string>

is_cached

enum<string>

request_prompt

enum<string>

response_text

enum<string>

properties

object

values

object

isCached

boolean

includeInputs

boolean

isPartOfExperiment

boolean

isScored

boolean

The following API lets you get all of the requests that would be visible in the request table at helicone.ai/requests.

Premade examples 👇

Filter	Description
Get Request by User	Get all the requests made by a user

Filter

A filter is either a FilterLeaf or a FilterBranch, and can be composed of multiple filters generating an AST of ANDs/ORs.

Here is how it is represented in typescript:

export interface FilterBranch {
  left: FilterNode;
  operator: "or" | "and"; // Can add more later
  right: FilterNode;
}

export type FilterNode = FilterLeaf | FilterBranch | "all";

This allows us to build complex filters like this:

{
  "filter": {
    "operator": "and",
    "right": {
      "request": {
        "model": {
          "contains": "gpt-4"
        }
      }
    },
    "left": {
      "request": {
        "user_id": {
          "equals": "abc@email.com"
        }
      }
    }
  }
}

Authorizations

authorization

string

headerrequired

Body

application/json

Request query filters

filter

required

From T, pick a set of properties whose keys are in the union K

filter.request_response_rmt

object

Make all properties in T optional

filter.request_response_rmt.latency

object

Make all properties in T optional

filter.request_response_rmt.status

object

Make all properties in T optional

filter.request_response_rmt.request_created_at

object

Make all properties in T optional

filter.request_response_rmt.response_created_at

object

Make all properties in T optional

filter.request_response_rmt.model

object

Make all properties in T optional

filter.request_response_rmt.user_id

object

Make all properties in T optional

filter.request_response_rmt.organization_id

object

Make all properties in T optional

filter.request_response_rmt.node_id

object

Make all properties in T optional

filter.request_response_rmt.job_id

object

Make all properties in T optional

filter.request_response_rmt.threat

object

Make all properties in T optional

filter.request_response_rmt.request_id

object

Make all properties in T optional

filter.request_response_rmt.prompt_tokens

object

Make all properties in T optional

filter.request_response_rmt.completion_tokens

object

Make all properties in T optional

filter.request_response_rmt.total_tokens

object

Make all properties in T optional

filter.request_response_rmt.target_url

object

Make all properties in T optional

filter.request_response_rmt.properties

object

filter.request_response_rmt.search_properties

object

filter.request_response_rmt.scores

object

filter.request_response_rmt.scores_column

object

Make all properties in T optional

filter.request_response_rmt.request_body

object

Make all properties in T optional

filter.request_response_rmt.response_body

object

Make all properties in T optional

filter.response

object

Make all properties in T optional

filter.request

object

Make all properties in T optional

filter.request.prompt

object

Make all properties in T optional

filter.request.created_at

object

Make all properties in T optional

filter.request.user_id

object

Make all properties in T optional

filter.request.auth_hash

object

Make all properties in T optional

filter.request.org_id

object

Make all properties in T optional

filter.request.id

object

Make all properties in T optional

filter.request.node_id

object

Make all properties in T optional

filter.request.model

object

Make all properties in T optional

filter.request.modelOverride

object

Make all properties in T optional

filter.request.path

object

Make all properties in T optional

filter.request.prompt_id

object

Make all properties in T optional

filter.feedback

object

Make all properties in T optional

filter.request_response_search

object

Make all properties in T optional

filter.sessions_request_response_rmt

object

Make all properties in T optional

filter.cache_hits

object

Make all properties in T optional

filter.cache_hits.organization_id

object

Make all properties in T optional

filter.cache_hits.request_id

object

Make all properties in T optional

filter.cache_hits.latency

object

Make all properties in T optional

filter.cache_hits.completion_tokens

object

Make all properties in T optional

filter.cache_hits.prompt_tokens

object

Make all properties in T optional

filter.cache_hits.created_at

object

Make all properties in T optional

filter.properties

object

filter.values

object

offset

number

limit

number

sort

object

isCached

boolean

includeInputs

boolean

isPartOfExperiment

boolean

isScored

boolean

Response

200 - application/json

data

object[]

required

data.response_id

string | null

required

data.response_created_at

string | null

required

data.response_body

any

data.response_status

number

required

data.response_model

string | null

required

data.request_id

string

required

data.request_created_at

string

required

data.request_body

any

required

data.request_path

string

required

data.request_user_id

string | null

required

data.request_properties

object

required

Construct a type with a set of properties K of type T

data.request_model

string | null

required

data.model_override

string | null

required

data.helicone_user

string | null

required

data.provider

required

Available options:

OPENAI,

ANTHROPIC,

AZURE,

LOCAL,

HELICONE,

AMDBARTEK,

ANYSCALE,

CLOUDFLARE,

2YFV,

TOGETHER,

LEMONFOX,

FIREWORKS,

PERPLEXITY,

GOOGLE,

OPENROUTER,

WISDOMINANUTSHELL,

GROQ,

COHERE,

MISTRAL,

DEEPINFRA,

QSTASH,

FIRECRAWL,

AWS

data.delay_ms

number | null

required

data.time_to_first_token

number | null

required

data.total_tokens

number | null

required

data.prompt_tokens

number | null

required

data.completion_tokens

number | null

required

data.prompt_id

string | null

required

data.feedback_created_at

string | null

data.feedback_id

string | null

data.feedback_rating

boolean | null

data.signed_body_url

string | null

data.llmSchema

object

required

data.country_code

string | null

required

data.asset_ids

string[] | null

required

data.asset_urls

object

required

Construct a type with a set of properties K of type T

data.scores

object

required

Construct a type with a set of properties K of type T

data.costUSD

number | null

data.properties

object

required

Construct a type with a set of properties K of type T

data.assets

string[]

required

data.target_url

string

required

error

enum<number> | null

required

Was this page helpful?

Get User Metrics Submit Feedback

User

Request

Prompt

Dataset

Experiment

Customer

Premade examples 👇

Filter

Authorizations

Body

Response

User

Request

Prompt

Dataset

Experiment

Customer

​Premade examples 👇

​Filter

Authorizations

Body

Response

Premade examples 👇

Filter