Other endpoints

Download schema

Certified GMV growth series

POST

https://api-dev.clearway.to

/GET_INVESTOR_READ_GROWTH_SERIES

Certified GMV growth series › Request Body

months

integer

brandSlug

string

Certified GMV growth series › Responses

Certified pull envelope v2

InvestorReadApiEnvelope

success

boolean · enum · required

Enum values:

readApiVersion

integer · enum · required

Enum values:

InvestorReadApiCertification · required

data

object · required

responseProfile

string · enum

Enum values:

full

excel

POST/GET_INVESTOR_READ_GROWTH_SERIES

curl https://api-dev.clearway.to/GET_INVESTOR_READ_GROWTH_SERIES \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "months": 0,
  "brandSlug": "brandSlug"
}'

Example Request Body

{
  "months": 0,
  "brandSlug": "brandSlug"
}

json

Example Responses

{
  "success": true,
  "readApiVersion": 2,
  "certification": {
    "receiptId": "00000000-0000-0000-0000-000000000000",
    "manifestHash": "manifestHash",
    "snapshotId": "00000000-0000-0000-0000-000000000000",
    "contentHash": "contentHash",
    "scopeManifestHash": "scopeManifestHashaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "snapshotLineageHash": "snapshotLineageHashaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "projectionBindingHash": "projectionBindingHashaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "dataQualityScore": 0,
    "signatureVerified": true,
    "dataSource": "dataSource",
    "pulledAt": "2024-08-25T15:00:00Z",
    "keyPrefix": "keyPrefix",
    "idempotentReplay": true
  },
  "data": {},
  "responseProfile": "full"
}

json

application/json

Certified overview page bundle

POST

https://api-dev.clearway.to

/GET_INVESTOR_READ_PAGE_BUNDLE

Certified overview page bundle › Request Body

months

integer

responseProfile

string · enum

Enum values:

full

excel

Certified overview page bundle › Responses

200

Certified pull envelope v2

InvestorReadApiEnvelope

success

boolean · enum · required

Enum values:

readApiVersion

integer · enum · required

Enum values:

InvestorReadApiCertification · required

data

object · required

responseProfile

string · enum

Enum values:

full

excel

POST/GET_INVESTOR_READ_PAGE_BUNDLE

curl https://api-dev.clearway.to/GET_INVESTOR_READ_PAGE_BUNDLE \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "months": 0,
  "responseProfile": "full"
}'

Example Request Body

{
  "months": 0,
  "responseProfile": "full"
}

json

Example Responses

{
  "success": true,
  "readApiVersion": 2,
  "certification": {
    "receiptId": "00000000-0000-0000-0000-000000000000",
    "manifestHash": "manifestHash",
    "snapshotId": "00000000-0000-0000-0000-000000000000",
    "contentHash": "contentHash",
    "scopeManifestHash": "scopeManifestHashaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "snapshotLineageHash": "snapshotLineageHashaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "projectionBindingHash": "projectionBindingHashaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "dataQualityScore": 0,
    "signatureVerified": true,
    "dataSource": "dataSource",
    "pulledAt": "2024-08-25T15:00:00Z",
    "keyPrefix": "keyPrefix",
    "idempotentReplay": true
  },
  "data": {},
  "responseProfile": "full"
}

json

application/json

Certified unit economics take-rate trend

POST

https://api-dev.clearway.to

/GET_INVESTOR_READ_UNIT_ECONOMICS

Certified unit economics take-rate trend › Request Body

months

integer

brandSlug

string

Certified unit economics take-rate trend › Responses

Certified pull envelope v2

InvestorReadApiEnvelope

success

boolean · enum · required

Enum values:

readApiVersion

integer · enum · required

Enum values:

InvestorReadApiCertification · required

data

object · required

responseProfile

string · enum

Enum values:

full

excel

POST/GET_INVESTOR_READ_UNIT_ECONOMICS

curl https://api-dev.clearway.to/GET_INVESTOR_READ_UNIT_ECONOMICS \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "months": 0,
  "brandSlug": "brandSlug"
}'

Example Request Body

{
  "months": 0,
  "brandSlug": "brandSlug"
}

json

Example Responses

{
  "success": true,
  "readApiVersion": 2,
  "certification": {
    "receiptId": "00000000-0000-0000-0000-000000000000",
    "manifestHash": "manifestHash",
    "snapshotId": "00000000-0000-0000-0000-000000000000",
    "contentHash": "contentHash",
    "scopeManifestHash": "scopeManifestHashaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "snapshotLineageHash": "snapshotLineageHashaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "projectionBindingHash": "projectionBindingHashaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "dataQualityScore": 0,
    "signatureVerified": true,
    "dataSource": "dataSource",
    "pulledAt": "2024-08-25T15:00:00Z",
    "keyPrefix": "keyPrefix",
    "idempotentReplay": true
  },
  "data": {},
  "responseProfile": "full"
}

json

application/json

Certified valuation Monte Carlo bands (projection-bound; includes reproductionPack)

POST

https://api-dev.clearway.to

/GET_INVESTOR_READ_VALUATION_MC

Certified valuation Monte Carlo bands (projection-bound; includes reproductionPack) › Request Body

Certified valuation Monte Carlo bands (projection-bound; includes reproductionPack) › Responses

Certified pull envelope v2 with projectionBindingHash

InvestorReadApiEnvelope

success

boolean · enum · required

Enum values:

readApiVersion

integer · enum · required

Enum values:

InvestorReadApiCertification · required

data

object · required

responseProfile

string · enum

Enum values:

full

excel

POST/GET_INVESTOR_READ_VALUATION_MC

curl https://api-dev.clearway.to/GET_INVESTOR_READ_VALUATION_MC \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{}'

Example Request Body

{}

json

Example Responses

{
  "success": true,
  "readApiVersion": 2,
  "certification": {
    "receiptId": "00000000-0000-0000-0000-000000000000",
    "manifestHash": "manifestHash",
    "snapshotId": "00000000-0000-0000-0000-000000000000",
    "contentHash": "contentHash",
    "scopeManifestHash": "scopeManifestHashaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "snapshotLineageHash": "snapshotLineageHashaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "projectionBindingHash": "projectionBindingHashaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "dataQualityScore": 0,
    "signatureVerified": true,
    "dataSource": "dataSource",
    "pulledAt": "2024-08-25T15:00:00Z",
    "keyPrefix": "keyPrefix",
    "idempotentReplay": true
  },
  "data": {},
  "responseProfile": "full"
}

json

application/json

Certified brand retention cohort matrix

POST

https://api-dev.clearway.to

/GET_INVESTOR_READ_COHORTS

Certified brand retention cohort matrix › Request Body

months

integer

cohortMode

string · enum

Enum values:

vintage

observation

brandSlug

string

Certified brand retention cohort matrix › Responses

Certified pull envelope v2

InvestorReadApiEnvelope

success

boolean · enum · required

Enum values:

readApiVersion

integer · enum · required

Enum values:

InvestorReadApiCertification · required

data

object · required

responseProfile

string · enum

Enum values:

full

excel

POST/GET_INVESTOR_READ_COHORTS

curl https://api-dev.clearway.to/GET_INVESTOR_READ_COHORTS \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "months": 0,
  "cohortMode": "vintage",
  "brandSlug": "brandSlug"
}'

Example Request Body

{
  "months": 0,
  "cohortMode": "vintage",
  "brandSlug": "brandSlug"
}

json

Example Responses

{
  "success": true,
  "readApiVersion": 2,
  "certification": {
    "receiptId": "00000000-0000-0000-0000-000000000000",
    "manifestHash": "manifestHash",
    "snapshotId": "00000000-0000-0000-0000-000000000000",
    "contentHash": "contentHash",
    "scopeManifestHash": "scopeManifestHashaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "snapshotLineageHash": "snapshotLineageHashaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "projectionBindingHash": "projectionBindingHashaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "dataQualityScore": 0,
    "signatureVerified": true,
    "dataSource": "dataSource",
    "pulledAt": "2024-08-25T15:00:00Z",
    "keyPrefix": "keyPrefix",
    "idempotentReplay": true
  },
  "data": {},
  "responseProfile": "full"
}

json

application/json

Public receipt verification (no secret)

POST

https://api-dev.clearway.to

/GET_INVESTOR_VERIFY_READ_RECEIPT

Public receipt verification (no secret) › Request Body

receiptId

string · uuid · required

Public receipt verification (no secret) › Responses

Verified read-api receipt metadata

ReadReceiptVerifyResponse

success

boolean

verified

boolean

receiptId

string · uuid

manifestHash

string

snapshotId

string · uuid

pulledAt

string · date-time

readApiVersion

integer

scopeManifestHash

string

contentHash

string

snapshotLineageHash

string

resource

string

projectionBindingHash

string · minLength: 64 · maxLength: 64

POST/GET_INVESTOR_VERIFY_READ_RECEIPT

curl https://api-dev.clearway.to/GET_INVESTOR_VERIFY_READ_RECEIPT \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "receiptId": "00000000-0000-0000-0000-000000000000"
}'

Example Request Body

{
  "receiptId": "00000000-0000-0000-0000-000000000000"
}

json

Example Responses

{
  "success": true,
  "verified": true,
  "receiptId": "00000000-0000-0000-0000-000000000000",
  "manifestHash": "manifestHash",
  "snapshotId": "00000000-0000-0000-0000-000000000000",
  "pulledAt": "2024-08-25T15:00:00Z",
  "readApiVersion": 0,
  "scopeManifestHash": "scopeManifestHash",
  "contentHash": "contentHash",
  "snapshotLineageHash": "snapshotLineageHash",
  "resource": "resource",
  "projectionBindingHash": "projectionBindingHashaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}

json

application/json

Subscriptions

Certified GMV growth series

POST

https://api-dev.clearway.to

/GET_INVESTOR_READ_GROWTH_SERIES

Certified GMV growth series › Request Body

months

integer

brandSlug

string

Certified GMV growth series › Responses

Certified pull envelope v2

InvestorReadApiEnvelope

success

boolean · enum · required

Enum values:

readApiVersion

integer · enum · required

Enum values:

InvestorReadApiCertification · required

data

object · required

responseProfile

string · enum

Enum values:

full

excel

Certified overview page bundle

POST

https://api-dev.clearway.to

/GET_INVESTOR_READ_PAGE_BUNDLE

Certified overview page bundle › Request Body

months

integer

responseProfile

string · enum

Enum values:

full

excel

Certified overview page bundle › Responses

200

Certified pull envelope v2

InvestorReadApiEnvelope

success

boolean · enum · required

Enum values:

readApiVersion

integer · enum · required

Enum values:

InvestorReadApiCertification · required

data

object · required

responseProfile

string · enum

Enum values:

full

excel

Certified unit economics take-rate trend

POST

https://api-dev.clearway.to

/GET_INVESTOR_READ_UNIT_ECONOMICS

Certified unit economics take-rate trend › Request Body

months

integer

brandSlug

string

Certified unit economics take-rate trend › Responses

Certified pull envelope v2

InvestorReadApiEnvelope

success

boolean · enum · required

Enum values:

readApiVersion

integer · enum · required

Enum values:

InvestorReadApiCertification · required

data

object · required

responseProfile

string · enum

Enum values:

full

excel

Certified valuation Monte Carlo bands (projection-bound; includes reproductionPack)

POST

https://api-dev.clearway.to

/GET_INVESTOR_READ_VALUATION_MC

Certified valuation Monte Carlo bands (projection-bound; includes reproductionPack) › Request Body

Certified valuation Monte Carlo bands (projection-bound; includes reproductionPack) › Responses

Certified pull envelope v2 with projectionBindingHash

InvestorReadApiEnvelope

success

boolean · enum · required

Enum values:

readApiVersion

integer · enum · required

Enum values:

InvestorReadApiCertification · required

data

object · required

responseProfile

string · enum

Enum values:

full

excel

Public receipt verification (no secret)

POST

https://api-dev.clearway.to

/GET_INVESTOR_VERIFY_READ_RECEIPT

Public receipt verification (no secret) › Request Body

receiptId

string · uuid · required

Public receipt verification (no secret) › Responses

Verified read-api receipt metadata

ReadReceiptVerifyResponse

success

boolean

verified

boolean

receiptId

string · uuid

manifestHash

string

snapshotId

string · uuid

pulledAt

string · date-time

readApiVersion

integer

scopeManifestHash

string

contentHash

string

snapshotLineageHash

string

resource

string

projectionBindingHash

string · minLength: 64 · maxLength: 64