Lists a history of published Zaraz configuration records for a zone.
/zones/{zone_identifier}/settings/zaraz/v2/history
get
Zaraz
get-zones-zone_identifier-zaraz-history
null{
"enum": [
"#zaraz:publish"
]
}[
{
"in": "path",
"name": "zone_identifier",
"required": true,
"schema": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"readOnly": true,
"type": "string"
}
},
{
"description": "Ordinal number to start listing the results with. Default value is 0.",
"example": 0,
"in": "query",
"name": "offset",
"schema": {
"minimum": 0,
"type": "integer"
}
},
{
"description": "Maximum amount of results to list. Default value is 10.",
"example": 10,
"in": "query",
"name": "limit",
"schema": {
"minimum": 1,
"type": "integer"
}
},
{
"description": "The field to sort by. Default is updated_at.",
"example": "updated_at",
"in": "query",
"name": "sortField",
"schema": {
"enum": [
"id",
"user_id",
"description",
"created_at",
"updated_at"
],
"type": "string"
}
},
{
"description": "Sorting order. Default is DESC.",
"example": "DESC",
"in": "query",
"name": "sortOrder",
"schema": {
"enum": [
"DESC",
"ASC"
],
"type": "string"
}
}
]null{
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"success": {
"description": "Whether the API call was successful",
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"items": {
"allOf": [
{
"properties": {
"createdAt": {
"description": "Date and time the configuration was created",
"format": "date-time",
"type": "string"
},
"id": {
"description": "ID of the configuration",
"type": "integer"
},
"updatedAt": {
"description": "Date and time the configuration was last updated",
"format": "date-time",
"type": "string"
},
"userId": {
"description": "Alpha-numeric ID of the account user who published the configuration",
"type": "string"
}
},
"required": [
"id",
"createdAt",
"updatedAt",
"userId"
]
},
{
"example": {
"createdAt": "2023-02-23T05:05:55.155273Z",
"description": "Config with enabled ecommerce tracking",
"id": 12345,
"updatedAt": "2023-02-23T05:05:55.155273Z",
"userId": "278d0d0g123cd8e49d45ea64f12faa37"
},
"properties": {
"description": {
"description": "Configuration description provided by the user who published this configuration",
"type": "string"
}
},
"required": [
"description"
],
"type": "object"
}
]
},
"type": "array"
}
}
}
]
}
}
},
"description": "List Zaraz historical configuration records response"
},
"4XX": {
"content": {
"application/json": {
"schema": {
"properties": {
"errors": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": [
{
"code": 7003,
"message": "No route for the URI"
}
],
"minLength": 1
},
"messages": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": []
},
"result": {
"enum": [
null
],
"nullable": true,
"type": "object"
},
"success": {
"description": "Whether the API call was successful",
"enum": [
false
],
"example": false,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
}
}
},
"description": "List Zaraz historical configuration records failure"
}
}[
{
"api_token": []
},
{
"api_email": [],
"api_key": []
}
]