Agents

Get all agent logs in your environment

GET

Query parameters

environmentIdstringRequired
Environment ID
spaceIdstringOptional
Space ID
successbooleanOptional
Boolean
pageSizeintegerOptional
Number of logs to return in a page (default 20)
pageNumberintegerOptional
Based on pageSize, which page of records to return

Response

This endpoint returns an object
data
list of objects
A log of an agent execution
pagination
objectOptional
pagination info

Errors

GET
$curl -G https://api.x.flatfile.com/v1/agents/logs \
>     -H "Authorization: Bearer <token>" \
>     -d environmentId=us_env_YOUR_ID \
>     -d spaceId=us_sp_YOUR_ID \
>     -d success=true \
>     -d pageSize=20 \
>     -d pageNumber=1
Response
1{
2  "data": [
3    {
4      "eventId": "us_evt_YOUR_ID",
5      "success": true,
6      "createdAt": "2022-09-18T00:19:57.007Z",
7      "completedAt": "2022-09-18T00:20:04.007Z",
8      "duration": 500,
9      "topic": "space:created",
10      "context": {},
11      "log": "SUCCESS"
12    }
13  ],
14  "pagination": {
15    "currentPage": 3,
16    "pageCount": 50,
17    "totalCount": 100
18  }
19}
Built with