Data Freshness | SalesOS Docs

Generate a data freshness report

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

curl -X GET "https://api.salesos.org/v1/data-freshness/report" \
  -H "Authorization: Bearer <token>"

Data freshness report

Get recent data changes across entities

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Query Parameters

entityTypeRequiredstring

sinceRequiredstring

limitRequiredstring

curl -X GET "https://api.salesos.org/v1/data-freshness/changes?entityType=%3Cstring%3E&since=%3Cstring%3E&limit=%3Cstring%3E" \
  -H "Authorization: Bearer <token>"

Recent data changes

List freshness check jobs

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

curl -X GET "https://api.salesos.org/v1/data-freshness/jobs" \
  -H "Authorization: Bearer <token>"

List of freshness check jobs

Create a new freshness check job

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

curl -X POST "https://api.salesos.org/v1/data-freshness/jobs" \
  -H "Authorization: Bearer <token>"

Freshness check job created

Delete a freshness check job

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

idRequiredstring

curl -X DELETE "https://api.salesos.org/v1/data-freshness/jobs/<string>" \
  -H "Authorization: Bearer <token>"

Job deleted

Get data freshness configuration

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

curl -X GET "https://api.salesos.org/v1/data-freshness/config" \
  -H "Authorization: Bearer <token>"

Freshness configuration

Update data freshness configuration

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

curl -X PATCH "https://api.salesos.org/v1/data-freshness/config" \
  -H "Authorization: Bearer <token>"

Updated freshness configuration

Cancel a freshness check job

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Path Parameters

idRequiredstring

curl -X POST "https://api.salesos.org/v1/data-freshness/jobs/<string>/cancel" \
  -H "Authorization: Bearer <token>"

Job cancelled

Get stale records

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

Query Parameters

entityTypeRequiredstring

limitRequiredstring

curl -X GET "https://api.salesos.org/v1/data-freshness/stale?entityType=%3Cstring%3E&limit=%3Cstring%3E" \
  -H "Authorization: Bearer <token>"

Stale records

Get data freshness statistics

Authorization

AuthorizationRequiredBearer <token>

Enter your JWT token

In: header

curl -X GET "https://api.salesos.org/v1/data-freshness/stats" \
  -H "Authorization: Bearer <token>"

Freshness statistics