🧩 Service: AuditTrail​
🔧 Operation: getAuditLogs​
🔹 Change 1​
- Action:
replace - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
DATA_TYPE_UPDATED - Path:
paths.getAuditLogs.methodTypePlaceHolder.parameters.0.schema.type - New Schema:
"number"
🔹 Change 2​
- Action:
remove - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getAuditLogs.methodTypePlaceHolder.parameters.1
🔹 Change 3​
- Action:
remove - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getAuditLogs.methodTypePlaceHolder.parameters.2
🔹 Change 4​
- Action:
remove - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getAuditLogs.methodTypePlaceHolder.parameters.3
🔹 Change 5​
- Action:
remove - Type:
breaking - xGroup:
N/A - Schema Ref:
LogSchemaResponse - Schema Action:
PROPERTY_REMOVED - Path:
paths.getAuditLogs.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.docs
🔹 Change 6​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
AuditLogs - Schema Action:
PROPERTY_ADDED - Path:
paths.getAuditLogs.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.headers - New Schema:
{
"type": "array",
"description": "List of header objects associated with the audit logs.",
"items": {
"$ref": "#/components/schemas/AuditLogsHeaderObj"
}
}
🔹 Change 7​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
AuditLogs - Schema Action:
PROPERTY_ADDED - Path:
paths.getAuditLogs.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items - New Schema:
{
"type": "array",
"description": "List of audit log entries.",
"items": {
"$ref": "#/components/schemas/AuditLogItem"
}
}
🔹 Change 8​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
AuditLogs - Schema Action:
PROPERTY_ADDED - Path:
paths.getAuditLogs.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.page - New Schema:
{
"$ref": "#/components/schemas/Page"
}
🔹 Change 9​
- Action:
remove - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getAuditLogs.methodTypePlaceHolder.responses.400
🔹 Change 10​
- Action:
remove - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getAuditLogs.methodTypePlaceHolder.responses.500
🔹 Change 11​
- Action:
replace - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getAuditLogs.methodTypePlaceHolder.path - New Schema:
"/service/platform/webhook/v1.0/company/{company_id}/audit/logs"
🔹 Change 12​
- Action:
replace - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getAuditLogs.methodTypePlaceHolder.methodType - New Schema:
"post"
🔹 Change 13​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getAuditLogs.methodTypePlaceHolder.requestBody - New Schema:
{
"required": true,
"description": "Filter to fetch audit logs",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LogsTableRequestModel"
},
"examples": {
"success": {
"value": {
"filter": {
"start_date": "2024-05-15T18:29:59.000Z",
"end_date": "2026-05-17T18:29:59.000Z",
"entity_type": "brand",
"entity_value": [
"Store Code 1"
],
"action_type": [
"update"
],
"application_id": "652905068e3a9c2cc7aec5d6",
"user_id": "9ba29f78c0e22305640fab5e"
},
"page": {
"current": 1,
"size": 10,
"type": "number"
},
"order_by": [
{
"column": "date_time",
"order": "asc"
}
]
}
},
"failure": {
"value": {
"filter": {
"start_date": "2024-05-15T18:29:59.000Z",
"end_date": "2026-05-17T18:29:59.000Z",
"entity_type": "brand",
"entity_value": [
"Store Code 1"
],
"action_type": [
"update"
],
"user_id": "9ba29f78c0e22305640fab5e",
"search_value": 2
},
"page": {
"current": 1,
"size": 10,
"type": "number"
},
"order_by": [
{
"column": "date_time",
"order": "asc"
}
]
}
}
}
}
}
}
🔹 Change 14​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.getAuditLogs.methodTypePlaceHolder.security - New Schema:
[
{
"oauth2": [
"company/audit_trail/write"
]
}
]
🔧 Operation: createAuditLog​
🔹 Change 1​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
RequestBodyAuditLog --> LogMetaObj - Schema Action:
ADDITIONAL_PROPERTIES_ADDED - Path:
paths.createAuditLog.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.log_meta.properties.modifier.additionalProperties - New Schema:
true
🔹 Change 2​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
RequestBodyAuditLog --> LogMetaObj - Schema Action:
ADDITIONAL_PROPERTIES_ADDED - Path:
paths.createAuditLog.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.log_meta.properties.device_info.additionalProperties - New Schema:
true
🔹 Change 3​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
RequestBodyAuditLog --> LogMetaObj - Schema Action:
ADDITIONAL_PROPERTIES_ADDED - Path:
paths.createAuditLog.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.log_meta.properties.location.additionalProperties - New Schema:
true
🔹 Change 4​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
RequestBodyAuditLog --> LogMetaObj - Schema Action:
PROPERTY_ADDED - Path:
paths.createAuditLog.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.log_meta.properties.sessions - New Schema:
{
"type": "string"
}
🔹 Change 5​
- Action:
add - Type:
breaking - xGroup:
N/A - Schema Ref:
RequestBodyAuditLog - Schema Action:
ADDITIONAL_PROPERTIES_ADDED - Path:
paths.createAuditLog.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.log_payload.additionalProperties - New Schema:
true
🔹 Change 6​
- Action:
remove - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.createAuditLog.methodTypePlaceHolder.responses.400
🔹 Change 7​
- Action:
remove - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.createAuditLog.methodTypePlaceHolder.responses.500
🔹 Change 8​
- Action:
replace - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.createAuditLog.methodTypePlaceHolder.path - New Schema:
"/service/platform/webhook/v1.0/company/{company_id}/audit/logs/create"
🔹 Change 9​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
N/A - Path:
paths.createAuditLog.methodTypePlaceHolder.security - New Schema:
[
{
"oauth2": [
"company/settings/write"
]
}
]
🔧 Operation: getAuditLog​
🔹 Change 1​
- Action:
remove - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
OPERATION_ID_REMOVED - Path:
paths.getAuditLog
🔧 Operation: getEntityTypes​
🔹 Change 1​
- Action:
remove - Type:
breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
OPERATION_ID_REMOVED - Path:
paths.getEntityTypes
🔧 Operation: getEntityDetails​
🔹 Change 1​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
OPERATION_ID_ADDED - Path:
paths.getEntityDetails - New Schema:
{
"methodTypePlaceHolder": {
"description": "Get entiry type and its respective action for provided filters",
"summary": "Get entity details",
"operationId": "getEntityDetails",
"x-documentation": false,
"tags": [
"Entity"
],
"parameters": [
{
"$ref": "#/components/parameters/CompanyId"
}
],
"requestBody": {
"required": true,
"description": "Filter to fetch entity values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuditTrailReqModel"
},
"examples": {
"success": {
"value": {
"filter": {
"start_date": "2024-05-15T18:29:59.000Z",
"end_date": "2026-05-17T18:29:59.000Z",
"entity_type": "brand",
"entity_value": [
"Store Code 1"
],
"action_type": [
"update"
],
"application_id": "652905068e3a9c2cc7aec5d6",
"user_id": "9ba29f78c0e22305640fab5e"
}
}
},
"failure": {
"value": {
"filter": {
"start_date": "2024-05-15T18:29:59.000Z",
"end_date": "2026-05-17T18:29:59.000Z",
"entity_type": "brand",
"entity_value": [
"Store Code 1"
],
"action_type": [
"update"
],
"user_id": "9ba29f78c0e22305640fab5e",
"search_value": 2
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuditLogEntityDetailResp"
},
"examples": {
"success": {
"value": {
"items": [
{
"entity_type": "brand",
"action_types": [
"create",
"update"
],
"input_type": "text"
},
{
"entity_type": "Brand",
"action_types": [
"create",
"update"
],
"input_type": "dropdown"
}
]
}
}
}
}
}
}
},
"x-groups": [
"Audit Logs"
],
"security": [
{
"oauth2": [
"company/audit_trail/write"
]
}
],
"path": "/service/platform/webhook/v1.0/company/{company_id}/audit/entities",
"methodType": "post"
}
}
🔧 Operation: getEntityValues​
🔹 Change 1​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
OPERATION_ID_ADDED - Path:
paths.getEntityValues - New Schema:
{
"methodTypePlaceHolder": {
"description": "Get entiry values for provided filters",
"summary": "Get entity details",
"operationId": "getEntityValues",
"x-documentation": false,
"tags": [
"Entity"
],
"parameters": [
{
"$ref": "#/components/parameters/CompanyId"
}
],
"requestBody": {
"required": true,
"description": "Filter to fetch entity details",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuditTrailReqModel"
},
"examples": {
"success": {
"value": {
"filter": {
"start_date": "2024-05-15T18:29:59.000Z",
"end_date": "2026-05-17T18:29:59.000Z",
"entity_type": "brand",
"entity_value": [
"Store Code 1"
],
"action_type": [
"update"
],
"application_id": "652905068e3a9c2cc7aec5d6",
"user_id": "9ba29f78c0e22305640fab5e"
}
}
},
"failure": {
"value": {
"filter": {
"start_date": "2024-05-15T18:29:59.000Z",
"end_date": "2026-05-17T18:29:59.000Z",
"entity_value": [
"Store Code 1"
],
"action_type": [
"update"
],
"user_id": "9ba29f78c0e22305640fab5e"
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntityValueResp"
},
"examples": {
"success": {
"value": {
"items": [
"store1",
"store2"
]
}
}
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InputIssue"
},
"examples": {
"failure": {
"value": {
"message": "Payload is not valid"
}
}
}
}
}
}
},
"x-groups": [
"Audit Logs"
],
"security": [
{
"oauth2": [
"company/audit_trail/write"
]
}
],
"path": "/service/platform/webhook/v1.0/company/{company_id}/audit/entity/values",
"methodType": "post"
}
}
🔧 Operation: getLogHistory​
🔹 Change 1​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
OPERATION_ID_ADDED - Path:
paths.getLogHistory - New Schema:
{
"methodTypePlaceHolder": {
"description": "Get audit log history for provided log id",
"summary": "Get audit log history",
"operationId": "getLogHistory",
"x-documentation": false,
"tags": [
"Audit Log"
],
"parameters": [
{
"$ref": "#/components/parameters/CompanyId"
},
{
"$ref": "#/components/parameters/LogId"
},
{
"$ref": "#/components/parameters/PageNo"
},
{
"$ref": "#/components/parameters/PageSize"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuditLogsHistoryResp"
},
"examples": {
"success": {
"value": {
"items": [
{
"id": "688b423a5113016d859c4972",
"created_at": "2025-07-31T10:15:22.470Z",
"user": "Sumit Pareek",
"description": [
"theme.config.list",
"theme.updated_at"
]
},
{
"id": "688b42245113016d859c496e",
"created_at": "2025-07-31T10:15:00.457Z",
"user": "Sumit Pareek",
"description": [
"Themes Apply"
]
}
],
"page": {
"current": 1,
"size": 10,
"has_next": true,
"has_previous": false,
"type": "number"
}
}
}
}
}
}
}
},
"x-groups": [
"Audit Logs"
],
"security": [
{
"oauth2": [
"company/audit_trail/read"
]
}
],
"path": "/service/platform/webhook/v1.0/company/{company_id}/audit/log/{log_id}/history",
"methodType": "get"
}
}
🔧 Operation: getLogPayload​
🔹 Change 1​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
OPERATION_ID_ADDED - Path:
paths.getLogPayload - New Schema:
{
"methodTypePlaceHolder": {
"description": "Get audit log payload for provided log id",
"summary": "Get audit log payload",
"operationId": "getLogPayload",
"tags": [
"Audit Log"
],
"parameters": [
{
"$ref": "#/components/parameters/CompanyId"
},
{
"$ref": "#/components/parameters/LogId"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"payload": {
"type": "object",
"additionalProperties": true
}
}
},
"examples": {
"success": {
"value": {
"payload": {
"application": "6410113e2dab5ee749179e31",
"company": "197",
"created_at": "2023-07-21T05:15:43.869Z",
"is_selected": true,
"modified_at": "2023-12-12T11:25:47.886Z",
"name": "Algolia - getbrands"
}
}
}
}
}
}
}
},
"x-groups": [
"Audit Logs"
],
"security": [
{
"oauth2": [
"company/audit_trail/read"
]
}
],
"path": "/service/platform/webhook/v1.0/company/{company_id}/audit/log/{log_id}/payload",
"methodType": "get"
}
}
🔧 Operation: getLogDetails​
🔹 Change 1​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
OPERATION_ID_ADDED - Path:
paths.getLogDetails - New Schema:
{
"methodTypePlaceHolder": {
"description": "Get audit log details such as user info, device details for provided log id",
"summary": "Get audit log details",
"operationId": "getLogDetails",
"x-documentation": false,
"tags": [
"Audit Log"
],
"parameters": [
{
"$ref": "#/components/parameters/CompanyId"
},
{
"$ref": "#/components/parameters/LogId"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuditLogEventDetails"
},
"examples": {
"success": {
"value": {
"_id": "66614fd0476249a4fa46739a",
"created_at": 1722950386268,
"is_bulk_upload": false,
"user_details": {
"user_id": "2756f0b57d3ecdf55b9a20f9",
"first_name": "sandbox",
"last_name": "user",
"email": "sandbox@gofynd.com"
},
"event_details": {
"name": "Company",
"type": "create",
"id": "98114fd227e5c8c55b897e52"
},
"device_info": {
"user_agent": "axios/1.7.2",
"location": "107.1.24.230"
},
"application_details": {
"name": "Test Company - 1",
"id": "66614fd227e5c8c55b897e52",
"host": "test-company-1-hosted-audittrail.sandbox0.fynd.engineering"
}
}
}
}
}
}
}
},
"x-groups": [
"Audit Logs"
],
"security": [
{
"oauth2": [
"company/audit_trail/read"
]
}
],
"path": "/service/platform/webhook/v1.0/company/{company_id}/audit/log/{log_id}/details",
"methodType": "get"
}
}
🔧 Operation: compareLogs​
🔹 Change 1​
- Action:
add - Type:
non-breaking - xGroup:
N/A - Schema Ref:
N/A - Schema Action:
OPERATION_ID_ADDED - Path:
paths.compareLogs - New Schema:
{
"methodTypePlaceHolder": {
"description": "Compare logs for the provided gog id and return updated keys alog with their values",
"summary": "Compare log by ids",
"operationId": "compareLogs",
"tags": [
"Audit Log"
],
"parameters": [
{
"$ref": "#/components/parameters/CompanyId"
},
{
"$ref": "#/components/parameters/LogId"
},
{
"$ref": "#/components/parameters/CompareLogId"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuditLogCompareResp"
},
"examples": {
"success": {
"value": {
"items": [
{
"field": "inventory.brand",
"attributes": [
{
"value": "brands",
"action": "updated"
},
{
"value": "criteria",
"action": "updated"
}
],
"compare_from": [
{
"value": [
6876,
6994,
29499,
82088
]
},
{
"value": "explicit"
}
],
"compare_to": [
{
"value": [
"19"
]
},
{
"value": "all"
}
]
}
]
}
}
}
}
}
}
},
"x-groups": [
"Audit Logs"
],
"security": [
{
"oauth2": [
"company/audit_trail/write"
]
}
],
"path": "/service/platform/webhook/v1.0/company/{company_id}/audit/compare/{log_id}/to/{compare_log_id}",
"methodType": "get"
}
}