Skip to main content

Documentation Index

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

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

The Downloads API exports any data domain in your Oleria workspace as a CSV. Every request is asynchronous: you create a request, poll until it completes, then fetch the resulting CSV from a presigned URL. This page covers the lifecycle, the filter and sort grammar, and the full catalog of data contexts.

​
The asynchronous lifecycle

1

Create a download request

POST /v1/downloads with a JSON body that specifies the context (which data domain you want) and an optional params object with filters and sort order. The response is a DownloadRequest with a UUID id and status: "accepted".
POST /v1/downloads
{
  "context": "accessInventoryIdentitiesV2",
  "params": {
    "filterBy": [
      { "dataType": "string", "field": "department", "filterType": "eq", "values": ["Engineering"] }
    ],
    "sortBy": [
      { "field": "createdAt", "sortType": "desc" }
    ]
  }
}
2

Poll for completion

GET /v1/downloads/{id} returns the current state of the request. status transitions from accepted to either completed (with a presigned url) or failed (with a populated error object).
{
  "id": "b5d3a6e8-9c0f-4f3e-8a2b-1c6d7e8f9a0b",
  "status": "completed",
  "url": "https://...presigned-s3-url..."
}
Use exponential back-off when polling - large exports can take seconds to minutes depending on the data context and filter set.
3

Fetch the CSV

GET the presigned url directly. The URL expires after 5 minutes, so download or stream it to your destination as soon as the request completes. No Oleria authentication is required on the presigned URL itself.

​
Filtering and sorting

The params.filterBy array applies AND-combined filters to the data context before export. Each filter declares the column’s dataType, the field name, a filterType operator, and an array of values.
dataTypefilterType operators
stringeq, ne, in, notIn, contains, notContains, matches, isNull, isNotNull
numbereq, ne, gt, gte, lt, lte, between, in, notIn, isNull, isNotNull
booleaneq, ne, isNull, isNotNull
timestampeq, ne, gt, gte, lt, lte, between, last, isNull, isNotNull
enumeq, ne, in, notIn, isNull, isNotNull
Use params.sortBy to order results. Each entry takes a field and a sortType of asc or desc.
between and in expect multiple entries in the values array. last (timestamps only) expects a duration value such as 7d or 24h.

​
Data contexts

The context field on a download request controls which data domain is exported. The full enum is listed in the OpenAPI spec; below is the canonical grouping.
GroupExample contextsWhat it returns
Access InventoryaccessInventoryIdentitiesV2, accessInventoryAccountsV2, accessInventoryGroupsV2, accessInventoryRolesV2, accessInventoryNhiV2Snapshots of who has access to what, by identity / account / group / role.
Identity & Employeesidentities, employees, employeeAccessInsights, oleriaUsersCanonical identity and HR records, plus per-employee access posture.
UtilizationaccountUtilization, groupUtilizationAccountsActivity-weighted views of how access is actually used.
Risk & ActivityrisksV2, riskMonitoringDetail, activityAnalysisDetected risks, monitoring detail, and the raw activity log.
Identity AssessmentsidentityAssessmentEntitlementUtilization, identityAssessmentResourceInstanceUtilization, identityAssessmentRiskDownload, identityAssessmentSimilarGroupsPeriodic assessment outputs across entitlements and resources.
Identity Lifecycle (ILM)ilmEmployeeEvents, ilmWorkflowEmployeeEventsJoiner / mover / leaver events and the workflows they triggered.
External AccessexternalAccessUsers, externalAnonymousAccess, externalSharedAssetsThird-party users, anonymous shares, and externally shared assets.
Access RequestsaccessRequestsSubmitted access requests and their status.
ReferenceresourceInstances, unmanagedApplications, applicationAccounts, userGroupResource and application catalog data.
See the Downloads group in the sidebar for the complete enum, request schema, and field-level documentation on every endpoint.

​
Contact us

For questions about the Downloads API, contact us at support@oleria.com.