Skip to main content
Python
import os
from openlayer import Openlayer

client = Openlayer(
    api_key=os.environ.get("OPENLAYER_API_KEY"),
)
response = client.inference_pipelines.retrieve_users(
    inference_pipeline_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)
print(response.items)
{
  "items": [
    {
      "id": "user123",
      "dateOfFirstRecord": "2021-12-31T08:00:00Z",
      "dateOfLastRecord": "2022-01-02T08:00:00Z",
      "sessions": 3,
      "records": 15,
      "tokens": 5250,
      "cost": 0.125
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.openlayer.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your workspace API key. See Find your API key for more information.

Path Parameters

​
inferencePipelineId
string<uuid>
required

The inference pipeline id (a UUID).

Query Parameters

​
page
integer
default:1

The page to return in a paginated query.

Required range: x >= 1
​
perPage
integer
default:25

Maximum number of items to return per page.

Required range: 1 <= x <= 100
​
sortColumn
string

Name of the column to sort on

​
asc
boolean
default:true

Whether or not to sort on the sortColumn in ascending order.

Body

application/json
​
columnFilters
(SetColumnFilter · object | NumericColumnFilter · object | StringColumnFilter · object)[] | null
Maximum array length: 5
Example:
{
  "measurement": "openlayer_token_set",
  "operator": "contains_none",
  "value": ["cat"]
}
​
searchQueryOr
string[] | null
Maximum string length: 300
​
searchQueryAnd
string[] | null
Maximum string length: 300
​
notSearchQueryOr
string[] | null
Maximum string length: 300
​
notSearchQueryAnd
string[] | null
Maximum string length: 300
​
rowIdList
integer[] | null
​
excludeRowIdList
integer[] | null

Response

Response OK.

​
items
object[]
required

Array of user aggregation data