Get session enforcement state for poll/ack proxying

curl --request GET \
  --url https://platform.dev.timeback.com/insights/1.0/sessions/{sessionId}/enforcement-state \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://platform.dev.timeback.com/insights/1.0/sessions/{sessionId}/enforcement-state"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://platform.dev.timeback.com/insights/1.0/sessions/{sessionId}/enforcement-state', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://platform.dev.timeback.com/insights/1.0/sessions/{sessionId}/enforcement-state",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://platform.dev.timeback.com/insights/1.0/sessions/{sessionId}/enforcement-state"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://platform.dev.timeback.com/insights/1.0/sessions/{sessionId}/enforcement-state")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "caliperSessionId": "<string>",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "applicationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "authority": "LEGACY_BACKEND",
  "sessionContext": "UNKNOWN",
  "strikes": [
    {
      "strikeKey": "<string>",
      "strikeCount": 123,
      "warningBudget": 123,
      "warningBudgetGrant": 123,
      "requiredAction": "NONE"
    }
  ],
  "lockout": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "scopeType": "application",
    "scopeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "triggeringSessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "triggeringCaliperSessionId": "<string>",
    "triggeringInsightId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "ruleSlug": "<string>",
    "startsAt": "2023-11-07T05:31:56Z",
    "expiresAt": "2023-11-07T05:31:56Z",
    "lockoutStatus": "active",
    "revokedAt": "2023-11-07T05:31:56Z",
    "revokedByUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "revokeReason": "<string>",
    "dateCreated": "2023-11-07T05:31:56Z",
    "dateLastModified": "2023-11-07T05:31:56Z"
  },
  "notifications": [
    {
      "insightId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "signalId": "<string>",
      "strikeKey": "<string>",
      "insightTypeSlug": "<string>",
      "startedAtTime": "2023-11-07T05:31:56Z",
      "endedAtTime": "2023-11-07T05:31:56Z",
      "showStudentMessage": true,
      "disputed": true,
      "version": 123,
      "presentationVariant": "INFO",
      "enforcement": {
        "strikeKey": "<string>",
        "strikeCount": 123,
        "warningBudget": 123,
        "warningBudgetGrant": 123,
        "requiredAction": "NONE"
      }
    }
  ],
  "signalOutcomes": [
    {
      "signalId": "<string>",
      "strikeKey": "<string>",
      "insightId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "outcome": "ACCRUED"
    }
  ],
  "requiredAction": "NONE",
  "notificationContractVersion": 1,
  "notificationAuthorityState": "CURRENT",
  "authorityPendingReason": "<string>",
  "authorityUnavailableReason": "<string>",
  "authorityError": {
    "code": "STALE_REVISION",
    "message": "<string>",
    "retryable": true
  },
  "notificationRevision": 1,
  "serverTime": "2023-11-07T05:31:56Z",
  "currentPresentation": {
    "presentationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "incidentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "insightId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "insightTypeSlug": "<string>",
    "occurrenceNumber": 123,
    "revision": 123,
    "presentationStatus": "OFFERED",
    "presentationVariant": "INFO",
    "surfaceKind": "INSIGHT",
    "policyMode": "NOTIFY",
    "lockoutId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "offeredAt": "2023-11-07T05:31:56Z",
    "renderPayloadSchemaVersion": 123,
    "renderPayload": {
      "schemaVersion": 123,
      "surfaceKind": "INSIGHT",
      "requestedLocale": "<string>",
      "resolvedLocale": "<string>",
      "messageVersion": 123,
      "insightName": "<string>",
      "insightTimestampStart": "2023-11-07T05:31:56Z",
      "insightTimestampEnd": "2023-11-07T05:31:56Z",
      "warningNumber": 123,
      "numberWarnings": 123,
      "warningProgressSegments": [
        {
          "ordinal": 123,
          "state": "PASSED",
          "label": "<string>",
          "ariaLabel": "<string>",
          "kind": "WARNING"
        }
      ],
      "insightFullText": "<string>",
      "insightMessage": "<string>",
      "insightCoaching": "<string>",
      "title": "<string>",
      "body": "<string>",
      "bodyAddendum": "<string>",
      "consequenceText": "<string>",
      "contextLabel": "<string>",
      "violationTimeLabel": "<string>",
      "pillLabel": "<string>",
      "ruleDisclosure": {
        "collapsed": true,
        "heading": "<string>",
        "body": "<string>",
        "expandLabel": "<string>",
        "collapseLabel": "<string>",
        "toggleLabel": "<string>",
        "collapsedAriaLabel": "<string>",
        "expandedAriaLabel": "<string>"
      },
      "primaryAction": "ACKNOWLEDGE",
      "clientEffect": "NONE",
      "primaryActionLabel": "<string>",
      "acknowledgementConfirmationLabel": "<string>",
      "remediationPreview": "NONE",
      "remediationPreviewAriaLabel": "<string>",
      "remediationPreviewUnavailableText": "<string>",
      "canDispute": true,
      "disputeActionLabel": "<string>",
      "disputePlaceholder": "<string>",
      "disputeRequiredText": "<string>",
      "disputeMaxLength": 123,
      "disputeConfirmationLabel": "<string>",
      "disputeOptions": [
        {
          "id": "<string>",
          "ordinal": 123,
          "label": "<string>",
          "allowsText": true,
          "requiresText": true,
          "textLabel": "<string>",
          "textPlaceholder": "<string>",
          "textMaxLength": 123
        }
      ],
      "canSubmitFeedback": true,
      "thumbsDownAriaLabel": "<string>",
      "thumbsUpAriaLabel": "<string>"
    },
    "sourceHorizonSnapshot": {}
  },
  "lockoutPresentation": {
    "presentationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "lockoutId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "launchAttemptId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "revision": 123,
    "presentationStatus": "OFFERED",
    "offeredAt": "2023-11-07T05:31:56Z",
    "copyPayloadSchemaVersion": 123,
    "copyPayload": {
      "schemaVersion": 123,
      "surfaceKind": "TEST_LOCKED_OUT",
      "requestedLocale": "<string>",
      "resolvedLocale": "<string>",
      "messageVersion": 123,
      "testName": "<string>",
      "warningsUsed": 123,
      "cooldownDurationSeconds": 123,
      "expiresAt": "2023-11-07T05:31:56Z",
      "remainingSeconds": 123,
      "headerLabel": "<string>",
      "headerSubline": "<string>",
      "countdownLabel": "<string>",
      "reasonHeading": "<string>",
      "reasonBody": "<string>",
      "primaryActionLabel": "<string>",
      "readyLabel": "<string>",
      "readySubline": "<string>",
      "readyReasonBody": "<string>",
      "readyActionLabel": "<string>",
      "ariaLabel": "<string>",
      "readyAriaLabel": "<string>"
    }
  }
}

{
  "error": "Unauthorized request",
  "message": "Unauthorized request"
}

{
  "error": "Access forbidden",
  "message": "Access forbidden"
}

{
  "error": "Object not found",
  "message": "Object with ID {id} not found"
}

{
  "error": "Conflict",
  "message": "Insight type with slug 'ExampleSlug' already exists"
}

{
  "error": "Internal server error",
  "message": "Internal server error"
}

Insights

Get session enforcement state for poll/ack proxying

Assembles authority, per-key strike counts, active lockout, and in-session notification insights from the pinned snapshot and platform strike ledger. sessionId is the caliper session id. Requires a pinned session (409 if not).

sessionContext, and each notification’s presentationVariant and enforcement, are always returned. They are additive: a client that reads only the legacy fields sees an unchanged response.

V2 time labels (violationTimeLabel, suspendedTimeLabel, recap acknowledgedTimeLabel, and the TEST_SUSPENDED headerSubline) are relative strings derived per read from stored UTC timestamps and the response serverTime (just now / a minute ago / N minutes ago). The stored render_payload keeps the UTC absolute label as the audit record.

This endpoint is a pure read of recorded platform state; it does not run notification selection or mint presentations. A reminder for an acknowledged still-open incident is scheduled by the platform at cooldown expiry via internal evaluation, not on this request.

GET

insights

1.0

sessions

{sessionId}

enforcement-state

Get session enforcement state for poll/ack proxying

curl --request GET \
  --url https://platform.dev.timeback.com/insights/1.0/sessions/{sessionId}/enforcement-state \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://platform.dev.timeback.com/insights/1.0/sessions/{sessionId}/enforcement-state"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://platform.dev.timeback.com/insights/1.0/sessions/{sessionId}/enforcement-state', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://platform.dev.timeback.com/insights/1.0/sessions/{sessionId}/enforcement-state",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://platform.dev.timeback.com/insights/1.0/sessions/{sessionId}/enforcement-state"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://platform.dev.timeback.com/insights/1.0/sessions/{sessionId}/enforcement-state")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "caliperSessionId": "<string>",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "applicationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "authority": "LEGACY_BACKEND",
  "sessionContext": "UNKNOWN",
  "strikes": [
    {
      "strikeKey": "<string>",
      "strikeCount": 123,
      "warningBudget": 123,
      "warningBudgetGrant": 123,
      "requiredAction": "NONE"
    }
  ],
  "lockout": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "scopeType": "application",
    "scopeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "triggeringSessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "triggeringCaliperSessionId": "<string>",
    "triggeringInsightId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "ruleSlug": "<string>",
    "startsAt": "2023-11-07T05:31:56Z",
    "expiresAt": "2023-11-07T05:31:56Z",
    "lockoutStatus": "active",
    "revokedAt": "2023-11-07T05:31:56Z",
    "revokedByUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "revokeReason": "<string>",
    "dateCreated": "2023-11-07T05:31:56Z",
    "dateLastModified": "2023-11-07T05:31:56Z"
  },
  "notifications": [
    {
      "insightId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "signalId": "<string>",
      "strikeKey": "<string>",
      "insightTypeSlug": "<string>",
      "startedAtTime": "2023-11-07T05:31:56Z",
      "endedAtTime": "2023-11-07T05:31:56Z",
      "showStudentMessage": true,
      "disputed": true,
      "version": 123,
      "presentationVariant": "INFO",
      "enforcement": {
        "strikeKey": "<string>",
        "strikeCount": 123,
        "warningBudget": 123,
        "warningBudgetGrant": 123,
        "requiredAction": "NONE"
      }
    }
  ],
  "signalOutcomes": [
    {
      "signalId": "<string>",
      "strikeKey": "<string>",
      "insightId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "outcome": "ACCRUED"
    }
  ],
  "requiredAction": "NONE",
  "notificationContractVersion": 1,
  "notificationAuthorityState": "CURRENT",
  "authorityPendingReason": "<string>",
  "authorityUnavailableReason": "<string>",
  "authorityError": {
    "code": "STALE_REVISION",
    "message": "<string>",
    "retryable": true
  },
  "notificationRevision": 1,
  "serverTime": "2023-11-07T05:31:56Z",
  "currentPresentation": {
    "presentationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "incidentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "insightId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "insightTypeSlug": "<string>",
    "occurrenceNumber": 123,
    "revision": 123,
    "presentationStatus": "OFFERED",
    "presentationVariant": "INFO",
    "surfaceKind": "INSIGHT",
    "policyMode": "NOTIFY",
    "lockoutId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "offeredAt": "2023-11-07T05:31:56Z",
    "renderPayloadSchemaVersion": 123,
    "renderPayload": {
      "schemaVersion": 123,
      "surfaceKind": "INSIGHT",
      "requestedLocale": "<string>",
      "resolvedLocale": "<string>",
      "messageVersion": 123,
      "insightName": "<string>",
      "insightTimestampStart": "2023-11-07T05:31:56Z",
      "insightTimestampEnd": "2023-11-07T05:31:56Z",
      "warningNumber": 123,
      "numberWarnings": 123,
      "warningProgressSegments": [
        {
          "ordinal": 123,
          "state": "PASSED",
          "label": "<string>",
          "ariaLabel": "<string>",
          "kind": "WARNING"
        }
      ],
      "insightFullText": "<string>",
      "insightMessage": "<string>",
      "insightCoaching": "<string>",
      "title": "<string>",
      "body": "<string>",
      "bodyAddendum": "<string>",
      "consequenceText": "<string>",
      "contextLabel": "<string>",
      "violationTimeLabel": "<string>",
      "pillLabel": "<string>",
      "ruleDisclosure": {
        "collapsed": true,
        "heading": "<string>",
        "body": "<string>",
        "expandLabel": "<string>",
        "collapseLabel": "<string>",
        "toggleLabel": "<string>",
        "collapsedAriaLabel": "<string>",
        "expandedAriaLabel": "<string>"
      },
      "primaryAction": "ACKNOWLEDGE",
      "clientEffect": "NONE",
      "primaryActionLabel": "<string>",
      "acknowledgementConfirmationLabel": "<string>",
      "remediationPreview": "NONE",
      "remediationPreviewAriaLabel": "<string>",
      "remediationPreviewUnavailableText": "<string>",
      "canDispute": true,
      "disputeActionLabel": "<string>",
      "disputePlaceholder": "<string>",
      "disputeRequiredText": "<string>",
      "disputeMaxLength": 123,
      "disputeConfirmationLabel": "<string>",
      "disputeOptions": [
        {
          "id": "<string>",
          "ordinal": 123,
          "label": "<string>",
          "allowsText": true,
          "requiresText": true,
          "textLabel": "<string>",
          "textPlaceholder": "<string>",
          "textMaxLength": 123
        }
      ],
      "canSubmitFeedback": true,
      "thumbsDownAriaLabel": "<string>",
      "thumbsUpAriaLabel": "<string>"
    },
    "sourceHorizonSnapshot": {}
  },
  "lockoutPresentation": {
    "presentationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "lockoutId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "launchAttemptId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "revision": 123,
    "presentationStatus": "OFFERED",
    "offeredAt": "2023-11-07T05:31:56Z",
    "copyPayloadSchemaVersion": 123,
    "copyPayload": {
      "schemaVersion": 123,
      "surfaceKind": "TEST_LOCKED_OUT",
      "requestedLocale": "<string>",
      "resolvedLocale": "<string>",
      "messageVersion": 123,
      "testName": "<string>",
      "warningsUsed": 123,
      "cooldownDurationSeconds": 123,
      "expiresAt": "2023-11-07T05:31:56Z",
      "remainingSeconds": 123,
      "headerLabel": "<string>",
      "headerSubline": "<string>",
      "countdownLabel": "<string>",
      "reasonHeading": "<string>",
      "reasonBody": "<string>",
      "primaryActionLabel": "<string>",
      "readyLabel": "<string>",
      "readySubline": "<string>",
      "readyReasonBody": "<string>",
      "readyActionLabel": "<string>",
      "ariaLabel": "<string>",
      "readyAriaLabel": "<string>"
    }
  }
}

{
  "error": "Unauthorized request",
  "message": "Unauthorized request"
}

{
  "error": "Access forbidden",
  "message": "Access forbidden"
}

{
  "error": "Object not found",
  "message": "Object with ID {id} not found"
}

{
  "error": "Conflict",
  "message": "Insight type with slug 'ExampleSlug' already exists"
}

{
  "error": "Internal server error",
  "message": "Internal server error"
}

Authorizations

Authorization

string

header

required

OAuth 2.0 client credentials flow. Contact timeback@trilogy.com to request credentials for your application.

Path Parameters

sessionId

string

required

Caliper session id

Query Parameters

locale

string

Requested BCP 47 locale. Echoed as the response payload's requestedLocale. Served copy remains the default catalog locale (en) until catalog copy exists in a second locale; resolvedLocale reports the locale of the copy actually served.

Minimum string length: 1

timeZone

string

Accepted and ignored; V2 time labels are relative and do not use a client zone

Minimum string length: 1

lastAppliedRevision

integer

Last notification revision the client applied; ignored for selection authority

Required range: x >= 0

Response

Successful response with session enforcement state for poll proxying

caliperSessionId

string

required

organizationId

string<uuid>

required

userId

string<uuid>

required

applicationId

string<uuid>

required

authority

enum<string>

required

Available options:

LEGACY_BACKEND,

PLATFORM

sessionContext

enum<string>

required

The pinned mode of this session. Carries no consequence meaning on its own — read each notification's presentationVariant for that. UNKNOWN means the mode never reconciled, and such a session never accrues consequence. PROCTORED alone does not enforce: accrual also requires authority PLATFORM (see the authority field). A LEGACY_BACKEND proctored session returns PROCTORED with no strikes and INFO notifications.

Available options:

UNKNOWN,

STANDARD,

PROCTORED

strikes

object[]

required

Show child attributes

lockout

object | null

required

Persisted proctoring lockout record with audit fields

Show child attributes

notifications

object[]

required

Show child attributes

signalOutcomes

object[]

required

Show child attributes

requiredAction

enum<string>

required

Available options:

NONE,

RESUME,

END_SESSION

notificationContractVersion

enum<integer> | null

The contract pinned when this session initialized. Absent or null means the pin is still pending — never treat as version 1. Immutable once pinned for the lifetime of the session.

Available options:

1,

2

notificationAuthorityState

enum<string>

Whether the returned notification state is authoritative right now. PENDING_CONTEXT means the authorizing source cursor has not been received for this session, the source is UNAVAILABLE, required facts declared by the producer are not yet durable, or the authorizing VISION horizon has not yet reached the evidence — so the client retries rather than treating the absent presentation as "nothing to show". It does not depend on how recently the producer last published.

Available options:

CURRENT,

PENDING_CONTEXT,

INVALID_REQUEST,

UNAVAILABLE

authorityPendingReason

string | null

Nonblank when notificationAuthorityState is PENDING_CONTEXT.

authorityUnavailableReason

string | null

Nonblank when notificationAuthorityState is UNAVAILABLE.

authorityError

object | null

Typed authority failure. INVALID_PAYLOAD is retryable (true) and distinct from INVALID_ARGUMENT. INVALID_ARGUMENT is not retryable.

Show child attributes

notificationRevision

integer | null

Monotonic session notification revision for the committed poll snapshot. Null for PENDING_CONTEXT/UNAVAILABLE when the frozen transport omits it.

Required range: x >= 0

serverTime

string<date-time>

Platform evaluation time for the poll snapshot.

currentPresentation

object | null

The single live presentation for this session's open incident, or null. Only present for contract version 2 sessions.

Show child attributes

lockoutPresentation

object | null

The blocked-relaunch presentation for the current launch attempt, or null. Only present for contract version 2 sessions.

Show child attributes

⌘I