API reference

Insights

2 endpoints

Two computed dashboards, each a single call with no pagination. GET /api/v1/performance is post-trip quality: NPS, survey response rate, per-advisor breakdown, top suppliers and recent detractors over a window. GET /api/v1/retention is the forward view: anniversaries coming up, trips due a rebooking nudge, recent outreach and the referral codes that actually convert.

Both are computed fresh on every call rather than served from a cache, so treat them as a periodic pull, not a per-request lookup.

Post-trip quality snapshot

GET/api/v1/performance

Needs a key with the full scope.

Survey outcomes over a trailing window: how many invitations went out, how many were answered, the NPS that came back, the average segment rating, a per-advisor breakdown, the suppliers that scored best and the detractors worth calling.

Computed fresh on each call. Leave advisor_id off for the whole account.

Parameters

Query

window_daysenumdefault 90
Anything outside the allowed set falls back to 90.
one of306090180365
advisor_iduuid

Response · 200

dataobject
Show fieldsHide fields
- window_daysinteger
  The window actually used, after the allowlist.
- advisorobjectnullable
  Null when the snapshot covers the whole account.
  Show fieldsHide fields
  - iduuid
  - namestringnullable
  - emailstringnullable
- invitedinteger
  Survey invitations sent in the window.
- startedinteger
- completedinteger
- response_ratenumbernullable
  Completed over invited, 0 to 1.
- npsnumbernullable
  Net promoter score, -100 to 100.
- avg_segment_ratingnumbernullable
- per_advisorobject[]
  The same figures broken out per advisor.
- top_suppliersobject[]
- detractorsobject[]
  Recent low scorers, worth a call.
- complimentaryobjectnullable
  Goodwill and complimentary service figures for the window.

Responses

401Missing or invalid Bearer token
403Policy denied or account has no owner
429Rate limit exceeded

curl -X GET 'https://YOUR-CELL.lydira.com/api/v1/performance' \
  -H 'Authorization: Bearer sek_YOUR_API_KEY'

const response = await fetch(
  "https://YOUR-CELL.lydira.com/api/v1/performance",
  {
    method: "GET",
    headers: {
      "Authorization": "Bearer sek_YOUR_API_KEY",
    },
  },
);

if (!response.ok) throw new Error(`${response.status} ${await response.text()}`);
const data = await response.json();

import requests

response = requests.get(
    "https://YOUR-CELL.lydira.com/api/v1/performance",
    headers={
        "Authorization": "Bearer sek_YOUR_API_KEY",
    },
)
response.raise_for_status()
data = response.json()

require "net/http"
require "json"

uri = URI("https://YOUR-CELL.lydira.com/api/v1/performance")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer sek_YOUR_API_KEY"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { it.request(request) }
raise response.body unless response.is_a?(Net::HTTPSuccess)
data = JSON.parse(response.body)

<?php
$ch = curl_init("https://YOUR-CELL.lydira.com/api/v1/performance");
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST  => "GET",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER     => [
        "Authorization: Bearer sek_YOUR_API_KEY",
    ],
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);

Response

200

{
  "data": {
    "window_days": 90,
    "advisor": {
      "id": "9d2f7c3a-1b4e-4a7d-8e51-2c0f6b9a4d18",
      "name": "Ayşe Yılmaz",
      "email": "ayse@example.com"
    },
    "invited": 1,
    "started": 1,
    "completed": 1,
    "response_rate": 1,
    "nps": 1,
    "avg_segment_rating": 1,
    "per_advisor": [
      {}
    ],
    "top_suppliers": [
      {}
    ],
    "detractors": [
      {}
    ],
    "complimentary": {}
  }
}

Rebooking opportunities

GET/api/v1/retention