Fetch Audit Logs

Fetch Audit Logs API helps you to fetch the activity logs on actions performed by various users for your account on Clickpost

Suggest Edits

Overview

Using the Fetch Audit Logs API, enterprise can fetch detailed activity logs on the actions performed by various users on your account.

  1. To have this API activated for your account, please contact your Customer Success Manager.
  2. Once you have the API activated by Clickpost team, you can use the API as follows:

API gives all the activity logs performed for an hour together in the API response
To get all the activity logs between >= 2022-01-01 00:00:00 and < 2022-01-01 01:00:00 pass the epoch time for 2022-01-01 00:00:00 [Epoch time: 1640995200] in the API request.

📘

You can use https://www.epochconverter.com/ to get the Epoch times to test out the API.

Run in Postman API Reference

Usecase

This is a standard API which applies to all MPS (Multi-Piece Shipment) and SPS (Single Piece Shipment) orders

Geography

This is a standard API which supports all shipments created and transported within

  1. India
  2. North America
  3. Europe
  4. Middle East
  5. South East Asia

Query Parameters

Field NameData TypeFieldDescriptionMax LengthExample
keystringMandatoryUnique license key provided by Clickpost for the enterprise00000000-0000-0000-0000-000000000000
epochepochMandatoryepoch time for hour for which logs are to be retrived. Example: logs for 2022-01-02 00:00:00 [that is actions that happened from time >= 2022-01-02 00:00:00 till < 2022-01-02 01:00:00 will be available when log_epoch_time has value 1641081600]1641081600

Response

meta [meta parameters]

Field NameData TypeDescriptionExample
successBooleanIndicates the success of the API requesttrue
messageStringSUCCESS in case request was successfully processed by Clickpost, else returns error message."SUCCESS"
statusHTTP CodeThe HTTP response status code of the API request200

result [result parameters]

Field NameData TypeDescriptionExample
ip_addressStringIP address from where activity happened"36.255.9.166"
service_typeStringClickpost links each action to different service in the system. Current service types are

[There can be more services that are added in future]:

1. User Login: via SSO

2. User Login: via

3. Username/Password

4. Dashboard Report: Download

5. Create Subuser

6. Update Subuser

7. Carrier Settings: Active/Inactive		"Dashboard Report: Download"
log_uuidnumClickpost log ID for the activity [internal to Clickpost]"0180851d-921d-41af-8a59-002c46cf42ac"
usernamestringuser that performed the action"umar.ranginwala"
user_emailstringemail of user that performed the action"[email protected]"
payloadstringany payload received in the system from Dashboard to perform the required action{
"email_to_list": "[email protected]",
"report_identifier": "1",
"report_prequisite": "{'awb': ''}",
"subuser": "[email protected]"
}
created_atstringtime in UTC when the action was taken"2022-11-01T04:53:16"

API Response

{
    "meta": {
        "status": 200,
        "message": "Success",
        "success": true
    },
    "result": [{
            "ip_address": "36.255.9.166",
            "service_type": "Dashboard Report: Download",
            "log_uuid": "0180851d-921d-41af-8a59-002c46cf42ac",
            "username": "[email protected]",
            "user_email": "[email protected]",
            "payload": {
                "email_to_list": "[email protected]",
                "report_identifier": "1",
                "report_prequisite": "{'awb': ''}",
                "subuser": "[email protected]"
            },
            "created_at": "2022-01-17T04:53:16"
        },
        {
            "ip_address": "54.251.143.57",
            "service_type": "User Login: via SSO",
            "log_uuid": "1872ff72-d297-4d37-9f1a-b8b0a74dd3f9",
            "username": "[email protected]",
            "user_email": "[email protected]",
            "payload": null,
            "created_at": "2022-01-17T04:29:40"
        }
    ]
}

What actions are being captured in Fetch Audit Logs API?

• Courier Settings: Active/Inactive
• Create Subuser
• Update Subuser
• Dashboard Report: Download
• Upload AWB To Track
• Manual Update Order Status via Form
• Upload AWB To Track for Latch Shipments
• Update Channel
• Upload Remittance
• Dashboard Report: Download
• Upload Pre Assign AWB
• Upload Pre Assign AWB for Deletion
• Upload Blacklist Pincode
• Create Channel
• Upload Serviceable Pincode
• User Login: via Username/Password
• User Login: via SSO
• Create Store(s) via File Upload
• Create Cluster(s) via File Upload
• Manual Update Order Status via File Upload
• Add SMS Sender ID
• Update SMS Template
• Add SMS Template
• Delete Whatsapp Template
• Add Marketing Tools Event
• Create Order(s) via File Upload
• Allocation Rule: Create Filters/Ordered List Rule
• Notifications: Set User For IVRS
• Notifications: Add Whatsapp Template
• Notifications: Update Marketing Tools Gateway
• Notifications: Delete Marketing Tools Gateway
• Notifications: Add Marketing Tools Gateway
• Notifications: Update SMS Gateway
• Notifications: Delete Email Gateway
• Notifications: Delete SMS Template
• Notifications: Update Email Gateway
• Notifications: Add Email Gateway
• Notifications: Delete IVRS Template
• Notifications: Add SMS Gateway
• Notifications: Delete SMS Gateway
• Notifications: Update SMS Template
• Notifications: Add SMS Template
• Notifications: Delete Whatsapp Gateway
• Notifications: Add Whatsapp Gateway
• Notifications: Update Whatsapp Gateway
• Notifications: Update Whatsapp Template
• Notifications: Active/Inactive Service
• Notifications: Update SMS Sender ID
• Notifications: Add Email Template
• Notifications: Update Email Template
• Notifications: Delete Email Template
• Notifications: Delete IVRS Gateway
• Notifications: Add IVRS Gateway
• Notifications: Update IVRS Gateway
• Notifications: Add IVRS Template
• Courier Partner Mapping
• Channel Warehouse Mapping
• Un-Hold Order
• Hold Order
• Cancel Order
• Rerun Recommendation for Fulfillment
• Create Bulk Shipment
• Create Shipment
• Update Feedback Job Config
• Update Weightage
• Update Absolute Capping
• Update Percentage Allocation
• Active/Inactive Group Config
• Delete Filters/Ordered List Rule
• Create User
• Update User
• Update Role
• Delete Role
• Create Role

Updated over 1 year ago