Sign in
advice_session

[BETA] Retrieve the external metadata posted to a session.

Returns the stored JSON:API data document ({data, meta}). When nothing has been posted yet, returns an empty data document ({data: null}), so the frontend always gets a valid document. data is free-form — its shape is defined by the external system that posted it.

get/v2/advice_session/{session_id}/meta

Request

  • Base URL: https://api.test.deepalpha.dev
  • URL: https://api.test.deepalpha.dev/v2/advice_session/{session_id}/meta
  • Auth: one of:
    • OAuth 2 (client credentials, token URL /v1/auth/token)
    • HTTP bearer

Path parameters

session_idstring uuid required

Response

Successful response

dataobject nullable required

Free-form external result (e.g. a pre-order check outcome). Null when unset.

metaobject nullable

Free-form top-level details.

Changes

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