Skip to main content

AuditTrail

Tracks and logs all actions and changes made within a system, providing a detailed history of events for security and compliance purposes.

Audit Logs

An audit log, also referred to as an audit trail, functions like a chronological timeline, documenting events and activities within the Fynd ecosystem. These events encompass various actions performed by users, alterations made to data, adjustments to system settings, and other significant actions. Sellers leverage the audit log as a means to track changes across different aspects of their Fynd platform. They can monitor updates to products, including modifications to descriptions, prices, and availability. Additionally, sellers can keep tabs on alterations to sales channels, such as changes in website themes or configurations. The audit log also enables sellers to oversee adjustments made to extensions integrated into their account, ensuring they function as intended. Beyond these specific areas, sellers can stay informed about changes related to other crucial components of their account or the broader Fynd ecosystem. In summary, the audit log provides sellers with valuable insights into their Fynd account activities, facilitating the maintenance of organization and awareness of operational processes.

Operations
GET
/service/platform/audit-trail/v1.0/company/{company_id}/logs
# Get audit logs
POST
/service/platform/audit-trail/v1.0/company/{company_id}/logs
# Create an audit log
GET
/service/platform/audit-trail/v1.0/company/{company_id}/logs/{id}
# Get an audit log
GET
/service/platform/audit-trail/v1.0/company/{company_id}/entity-types
# List entity types
GET

Get audit logs

Retrieve audit logs for system events and actions.
Parameters
qs
string
Logs Query
limit
integer
Optional
Current request items count
sort
object
Optional
To sort based on _id
Properties
_id
integer
Optional
Enum
Response
200
400
500
Success
LogSchemaResponse
docs
array of object (LogDocs)
Optional
Array of LogDocs
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/audit-trail/v1.0/company/{company_id}/logs
Loading...
Response
Example response not available.
POST

Create an audit log

Generate and record an audit log entry for a specific event or action.
Parameters
body
object (RequestBodyAuditLog)
Log Details to be logged
RequestBodyAuditLog
log_meta
object (LogMetaObj)
LogMetaObj
log_payload
object
Response
200
400
500
Success
CreateLogResponse
message
string
Optional
internal_message
string
Optional
Examples
Parameters
body:
body
Was this section helpful?
POST
/service/platform/audit-trail/v1.0/company/{company_id}/logs
Loading...
Response
Loading...
GET

Get an audit log

Retrieve a specific audit log entry.
Parameters
id
string
log uuid
Response
200
400
500
Success
LogSchemaResponse
docs
array of object (LogDocs)
Optional
Array of LogDocs
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/audit-trail/v1.0/company/{company_id}/logs/{id}
Loading...
Response
Loading...
GET

List entity types

List of entity types that can be audited within the platform.
Parameters
No Parameters
Response
200
400
500
Success
EntityTypesResponse
items
array of object (EntityTypeObj)
Optional
Array of EntityTypeObj
Examples
Parameters
Parameters are not required.
Was this section helpful?
GET
/service/platform/audit-trail/v1.0/company/{company_id}/entity-types
Loading...
Response
Example response not available.