export

bulk export of point event timeseries

Returns up to 200 000 point events per request together with a nextUrl for the following page. Designed for full historical export of a customer's point event data and continuous delta export.

Initial request — POST with only customerId. The server finds the earliest observation time for the customer and returns events from that time onwards`.

Continuation — Follow nextUrl from the previous response (or pass its cursor query parameter manually). The cursor value is the cursor value from the previous response.

Repeat POST requests using each nextUrl until the export 0 events is returned. To get future events, store the nextUrl and use this at a scheduled interval to receive future events ensuring to always store and use the latest nextUrl from last response.

get/export/point-events

Request

  • Base URL
    https://api.relynk.io/v2.0.0
  • Auth
    • HTTP bearer
    • or API key in header Authorization

Query parameters

customerIdstring uuid required

customer id context, id can be fetched from /customers endpoint

cursorstring

pagination cursor

Response

page of compact point events with continuation URL

nextUrlstring uri required

absolute URL for the next POST request. Contains customerId and cursor query parameters. Follow this URL until a page returns zero.

Example response

{
  "events": [
    {
      "r": "0eb8e6e5-9ba4-4a0b-bbb0-41162e01d13b",
      "t": "2024-01-01T12:00:00Z",
      "v": 21.5
    }
  ],
  "nextUrl": "https://api.relynk.io/v2.0.0/export/point-events?customerId=123e4567-e89b-12d3-a456-426614174000&cursor=MTcwNDY3MjAwMDow"
}

Changes

No recorded changes to this operation across all 1 revision of this API.