Filtering audit API to date ranges / pagination

Integrator.io
, , ,
1

In the Audit API endpoints, there isn't much info on how I can filter the response in my request.

https://docs.celigo.com/hc/en-us/articles/7708497540123-Audit-API-endpoints

This informational page: https://docs.celigo.com/hc/en-us/articles/6514515710107 says that a max of 1000 records are produced by the API response. Given this I have a couple of questions.

  • In the UI you can adjust the custom date field to get records for a given date range. Can I pass some parameters or headers to request only logs for a given date range via the various audit apis?
  • If in the above example the date range I am interested in produces more than 1000 records, can I page through them to request more?

Thanks!

2

@jeremynelson [Updated on Dec 13th] We currently do support filtering the data from the API by dates (see The responses below) . The good news is that we are working on Audit log so that you are no longer bound by UI limitation (i.e can only see up to 1500 records at a time). This enhancement is targeted for our January 2023 release.

Also, we have a product portal that you can find out what features are bing planned or ideas that need input from our users. See image below how to get to our product portal and browse for ideas and vote...

5301043caa20740200000001-27c5ca587ae8474aa3f1c85e7427ea95.png
5301043caa20740200000001-27c5ca587ae8474aa3f1c85e7427ea95.png1917×642 116 KB

3

Thanks for the response @viliandyleonardo Do I understand correctly that:

  • Next year, the API response will contain entire resultset or at least a way to page through it?
  • Requesting logs from the API created after a specific date will still not be possible so i'll have to parse the entire result set to get timestamps i'm interested in?
4

@jeremynelson

I will have the team in charge of this enhancement to review your follow up questions and respond.

Thanks

5

@jeremynelson, it is possible to page through the audit endpoint. In the response header, there is a link to the next page. Now, I'm not aware of any current filter parameters, but have asked internally.

5301043caa20740200000001-139dc5808bdd42eca4df5f4cb1a9d7fa.png
5301043caa20740200000001-139dc5808bdd42eca4df5f4cb1a9d7fa.png1516×819 37.5 KB

5301043caa20740200000001-bbd992ad6ebb4617a8a368b7978ee1cb.png
5301043caa20740200000001-bbd992ad6ebb4617a8a368b7978ee1cb.png1420×945 61.8 KB

6

When I look at the results I get from this

curl -H "Authorization: Bearer $token" https://api.integrator.io/v1/flows/$flow_id/audit

I only get a list of resource flow records like the below, with nothing else. There is no paging detail here.

  [{
    "_id": "123434343",
    "resourceType": "flow",
    "_resourceId": "432434343",
    "source": "ui",
    "fieldChanges": [],
    "event": "create",
    "time": "2022-08-09T14:59:28.039Z",
    "byUser": {
      "_id": "343243fdfdsfd",
      "email": "user@domain.com",
      "name": "User Name"
    }
  }
]

7

It is in the HTTP response "headers".

8

Ah! ok thanks! I will now await if there is a way to grab specific dates. Thank you!

9

Hello @jeremynelson

  • Yes, you can already apply date filters as parameters to API request to get the records for a specific date range, this is available now.
  • In January release, we will make user interface enhancement but not the APIs. The API response won't include all result; the api will still return 1000 records per request, and you need to paginate.

I hope this information is helpful, please let me know if you have any further questions. I will be happy assist.

Thank you.

10

Hello @jeremynelson

Here is an example of how the request URI appears with a date filter added as a parameter.

Example: https://api.integrator.io/v1/flows/<_id>/audit?from=YYYY-MM-DD&to=YYYY-MM-DD

Note: <_id> is the flow-id

Thank you.