Skip to content
All Alpha Armory Docs

Feed heartbeat + catalog version

GET
/v1/catalog/health
curl --request GET \
  --url 'https://api.oldsteelarsenal.com/v1/catalog/health?distributor=rsr' \
  --header 'x-client-id: <x-client-id>' \
  --header 'x-signature: <x-signature>' \
  --header 'x-timestamp: <x-timestamp>'

Last successful ingest per feed (from sync_runs), the catalog version token (= last catalog ingest time, cache key material), and row counts. The POS watchdog reads last_quantity_sync_at as the feed heartbeat. Scope: catalog:read.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters”
distributor
Distributor
string
default: rsr

Header Parameters

Section titled “Header Parameters”
x-client-id
Any of:
string
x-timestamp
Any of:
string
x-signature
Any of:
string

Responses

Section titled “ Responses ”

200

Section titled “200”

Successful Response

Media typeapplication/json
CatalogHealthResponse
object
catalog_version
required
Catalog Version
string
contract_version
Contract Version
string
default: 1.0
distributor
required
Distributor
string
last_catalog_sync_at
required
Any of:
string format: date-time
last_quantity_sync_at
required
Any of:
string format: date-time
last_restrictions_sync_at
required
Any of:
string format: date-time
offers_active
required
Offers Active
integer
offers_total
required
Offers Total
integer
Example
{
  "contract_version": "1.0"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}