API Reference

Zaraz

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

History

List Zaraz historical configuration records

client.zaraz.history.list(HistoryListParams { zone_id, limit, offset, 2 more } params, RequestOptionsoptions?): SinglePage<HistoryListResponse { id, createdAt, description, 2 more } >

GET/zones/{zone_id}/settings/zaraz/history

Restore Zaraz historical configuration by ID

client.zaraz.history.update(HistoryUpdateParams { zone_id, body } params, RequestOptionsoptions?): Configuration { dataLayer, debugKey, settings, 7 more }

PUT/zones/{zone_id}/settings/zaraz/history

ModelsExpand Collapse

HistoryListResponse { id, createdAt, description, 2 more }

id: number

ID of the configuration.

createdAt: string

Date and time the configuration was created.

formatdate-time

description: string

Configuration description provided by the user who published this configuration.

updatedAt: string

Date and time the configuration was last updated.

formatdate-time

userId: string

Alpha-numeric ID of the account user who published the configuration.

HistoryConfigs

Get Zaraz historical configurations by ID(s)

client.zaraz.history.configs.get(ConfigGetParams { zone_id, ids } params, RequestOptionsoptions?): ConfigGetResponse { id, config, createdAt, 2 more }

GET/zones/{zone_id}/settings/zaraz/history/configs

ModelsExpand Collapse

ConfigGetResponse = Record<string, item>

Object where keys are numeric configuration IDs.

id: number

ID of the configuration.

config: Configuration { dataLayer, debugKey, settings, 7 more }

Zaraz configuration.

createdAt: string

Date and time the configuration was created.

formatdate-time

updatedAt: string

Date and time the configuration was last updated.

formatdate-time

userId: string

Alpha-numeric ID of the account user who published the configuration.