Inspect a customer session's uploads and proofs

GET

/v1/admin/sessions/{id}

const url = 'https://api.pixonaut.app/v1/admin/sessions/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.pixonaut.app/v1/admin/sessions/example \
  --header 'Authorization: Bearer <token>'

Operation ID: customerSessions.get

Lists every upload and proof one designer session left behind, with when each was made and when each proof expires. retained is 1 for one that a committed design or a published template uses, which is kept for as long as that use lasts and which a wipe does not delete, and 0 for one that expires on its own. For support, and for checking what a wipe kept; a storefront does not need it.

Authorizations

secretKey

Parameters

Path Parameters

required

string

Responses

200

The session’s assets and proofs

application/json

object

assets

required

Array<object>

object

createdAt

required

number

required

string

layerId

required

string | null

mime

required

string

retained

required

number

sizeBytes

required

number

templateId

required

string | null

proofs

required

Array<object>

object

createdAt

required

number

docHash

required

string

expiresAt

required

number

required

string

retained

required

number

templateId

required

string

Examples

example

Example

{
  "assets": [
    {
      "createdAt": 1760000000000,
      "id": "b7e2c4a1-9d3f-4a6b-8e5c-2f1d0a9b8c7e",
      "layerId": "motif",
      "mime": "image/png",
      "retained": 0,
      "sizeBytes": 482113,
      "templateId": "tshirt-basic@2"
    }
  ],
  "proofs": [
    {
      "createdAt": 1760000060000,
      "docHash": "3f8a1c5d9e2b7a40c6d1e8f35b9a2c74d0e6f1a8b3c5d7e9f2a4b6c8d0e1f3a5",
      "expiresAt": 1760086400000,
      "id": "prf_9c1e2d3f4a5b6c7d8e9f0a1b",
      "retained": 0,
      "templateId": "tshirt-basic@2"
    }
  ]
}

Headers

X-Request-Id

required

string

Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.

401

Refused: unauthorized

application/json

object

error

required

string

Examples

unauthorized

{
  "error": "unauthorized"
}

Headers

X-Request-Id

required

string

403

Refused: origin_forbidden, secret_key_required, feature_disabled

application/json

object

error

required

string

feature

The feature the tenant does not have. Always sent with feature_disabled.

string

Examples

feature_disabled

{
  "error": "feature_disabled",
  "feature": "api"
}

origin_forbidden

{
  "error": "origin_forbidden"
}

secret_key_required

{
  "error": "secret_key_required"
}

Headers

X-Request-Id

required

string

500

Refused: db_error. A request that failed unexpectedly answers as text instead.

object

error

required

string

Examples

db_error

{
  "error": "db_error"
}

Headers

X-Request-Id

required

string

Questions? Write to [email protected].

Status · Terms of service · Privacy policy · Subprocessors