assets

Embed
Preview of the card
<a href="https://hermetica.15.204.158.166.sslip.io/docs/ref-assets"><img src="https://hermetica.15.204.158.166.sslip.io/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/cfdfbcc6-a6d4-4a3e-be3c-f14f35712c4d/social-card.svg?v=3e7ae33eec8b" alt="assets" width="600" height="315"></a>
GEThttps://hermetica.15.204.158.166.sslip.io/v1/assets/{id}/tracked-links

Parameters

idstringpathrequired

Code samples

cURL
curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/assets/{id}/tracked-links" \
  -H "Authorization: Bearer $SSLIP_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "assetId": "string",
      "label": "string",
      "downloads": 0,
      "revoked": true,
      "createdAt": "2024-01-01T00:00:00Z",
      "url": "string"
    }
  ]
}
Schema
itemsobject[]required
Show child parameters
idstringrequired
assetIdstringrequired
labelstringrequired
downloadsintegerrequired
revokedbooleanrequired
createdAtstringrequired
urlstringrequired
4XX Default Response
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
detailsobject
5XX Default Response

Same as 4XX · GET /v1/assets/{id}/tracked-links

POSThttps://hermetica.15.204.158.166.sslip.io/v1/assets/{id}/tracked-links

Parameters

idstringpathrequired

Request body

application/json
labelstring
{
  "label": ""
}

Code samples

cURL
curl -X POST "https://hermetica.15.204.158.166.sslip.io/v1/assets/{id}/tracked-links" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"label":""}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

201 Default Response
Example
{
  "id": "string",
  "assetId": "string",
  "label": "string",
  "downloads": 0,
  "revoked": true,
  "createdAt": "2024-01-01T00:00:00Z",
  "url": "string"
}
Schema
idstringrequired
assetIdstringrequired
labelstringrequired
downloadsintegerrequired
revokedbooleanrequired
createdAtstringrequired
urlstringrequired
4XX Default Response

Same as 4XX · GET /v1/assets/{id}/tracked-links

5XX Default Response

Same as 4XX · GET /v1/assets/{id}/tracked-links

GEThttps://hermetica.15.204.158.166.sslip.io/v1/tracked-links/{id}/profile-url

The link personalised for one profile (use it in that profile's messages)

Parameters

profileIdstringqueryrequired
idstringpathrequired

Code samples

cURL
curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/tracked-links/{id}/profile-url?profileId=<profileId>" \
  -H "Authorization: Bearer $SSLIP_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "url": "string"
}
Schema
urlstringrequired
4XX Default Response

Same as 4XX · GET /v1/assets/{id}/tracked-links

5XX Default Response

Same as 4XX · GET /v1/assets/{id}/tracked-links

DELETEhttps://hermetica.15.204.158.166.sslip.io/v1/tracked-links/{id}

Revoke a tracked link

Parameters

idstringpathrequired

Code samples

cURL
curl -X DELETE "https://hermetica.15.204.158.166.sslip.io/v1/tracked-links/{id}" \
  -H "Authorization: Bearer $SSLIP_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "ok": true
}
Schema
okbooleanrequired
true
4XX Default Response

Same as 4XX · GET /v1/assets/{id}/tracked-links

5XX Default Response

Same as 4XX · GET /v1/assets/{id}/tracked-links

GEThttps://hermetica.15.204.158.166.sslip.io/f/{ws}/{id}/{*}

A not-indexable or private library file: private files need a valid signed link (?t=); always answered with noindex

Parameters

tstringquery
wsstringpathrequired
idstringpathrequired
*stringpathrequired

Code samples

cURL
curl -X GET "https://hermetica.15.204.158.166.sslip.io/f/{ws}/{id}/{*}" \
  -H "Authorization: Bearer $SSLIP_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

302 Default Response
"string"
4XX Default Response

Same as 4XX · GET /v1/assets/{id}/tracked-links

5XX Default Response

Same as 4XX · GET /v1/assets/{id}/tracked-links

POSThttps://hermetica.15.204.158.166.sslip.io/v1/assets/query

Filter assets with a typed where / orderBy / limit / offset (fields are an allowlist; read "fields" in the result)

Request body

application/json
whereobject[]
= []
Show child parameters
fieldstringrequired
opstringrequired
eq | ne | gt | gte | lt | lte | contains | starts_with | in | is_null | not_null
valuestring | number | boolean | string | number[]
orderByobject[]
= []
Show child parameters
fieldstringrequired
dirstring
asc | desc = asc
limitinteger
= 50
offsetinteger
= 0
{
  "where": [],
  "orderBy": [],
  "limit": 50,
  "offset": 0
}

Code samples

cURL
curl -X POST "https://hermetica.15.204.158.166.sslip.io/v1/assets/query" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"where":[],"orderBy":[],"limit":50,"offset":0}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {}
  ],
  "fields": [
    "string"
  ],
  "hasMore": true
}
Schema
itemsobject[]required
fieldsstring[]required
hasMorebooleanrequired
4XX Default Response

Same as 4XX · GET /v1/assets/{id}/tracked-links

5XX Default Response

Same as 4XX · GET /v1/assets/{id}/tracked-links

Updated