Audit API endpoints

Kathyana Queeman

Updated October 07, 2024 17:43

API endpoints

This API is typically needed to monitor and provide insight into the history, success, or failure of the resource.

Relative URI	Method	Success code	Description
`/audit`	`GET`	`200`	Get all audit information for your account.
`/flows/<_id>/audit`	`GET`	`200`	Get a log for a specific flow.
`/connections/<_id>/audit`	`GET`	`200`	Get a log for a specific connection.
`/integrations/<_id>/audit`	`GET`	`200`	Get a log for a specific integration.
`/exports/<_id>/audit`	`GET`	`200`	Get a log for a specific export.
`/imports/<_id>/audit`	`GET`	`200`	Get a log for a specific import.
`/apis/<_id>/audit`	`GET`	`200`	Get a log for a specific My API.
`/scripts/<_id>/audit`	`GET`	`200`	Get a log for a specific script.
`/accesstokens/<_id>/audit`	`GET`	`200`	Get a log for a specific access token.

Audit API examples

Sample GET response

"audit": [
          {
            "_id": "•••••••••••••",
            "resourceType": "export",
            "_resourceId": "••••••••••••••••••••••••••",
            "source": "UI",
            "fieldChanges": [
               {
                    "newValue": {
                       "resource": "customers",
                       "version": "v2",
                       "operation": "getacountof_customergroups"
                },
             "fieldPath": "assistantMetadata"
                },
                {
                  "oldValue": "RESTExport",
                  "newValue": "RESTExport",
          }
        ]

Delta examples

This endpoint allows delta exporting by passing in a to and from parameter.

/audit?from=2023-11-07T23:14:43.032Z&to=2023-11-08T23:14:43.032Z

This extracts data from November 7, 2023 to November 8, 2023.

/audit?from=2023-11-07T23:14:43.032Z

This extracts data from November 7, 2023.

/audit?to=2023-11-08T23:14:43.032Z

This extracts data up to November 8, 2023.

Comments

1 comment

Tyler Lamparter
November 09, 2023 23:26

Principal Product Manager
This endpoint allows delta exporting by passing in a to and from parameter. For example,
```
/audit?from=2023-11-07T23:14:43.032Z&to=2023-11-08T23:14:43.032Z
```
```
/audit?from=2023-11-07T23:14:43.032Z
```
```
/audit?to=2023-11-08T23:14:43.032Z
```
0

Please sign in to leave a comment.