Get an App's Logs

Prev Next
Get
/app/{id}/logs

Use this endpoint to get a specific app's logs for your workspace. Permission required: manage-apps

Header parameters
X-Auth-Token
stringRequired

The authToken of the authenticated user.

ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired

The userId of the authenticated user.

ExamplerbAXPnMktTFbNpwtJ
Path parameters
id
stringRequired

Enter the app ID for which you want to view the logs results.

Examplefc96e832-5472-49e4-aace-1521a7ebeaa6
Query parameters
method
string

An app lifecycle has many phases which you can view from the Logs section of an app's App Info page. These phases are the methods that are are invoked by an app depending on its settings and user interactions.

Exampleapp:construct
logLevel
string

The log level refers to the type of logs you want to view. Enter 0 to view errors, 1 for errors and information, and 2 for errors, information, and debugging details.

Example1
startDate
string

Enter the start date from which you want the logs results. The format is ISO string.

Example2025-05-25T06:06:45.954Z
endDate
string

Enter the end date till which you want to view the logs. The format is ISO string.

Example2025-05-25T06:06:45.954Z
offset
number

Number of items to "skip" in the query, i.e. requests return count items, skipping the first offset items. Refer to the official documentation to learn more.

Example50
count
number

The number of items to return. Refer to the official documentation to learn more.

Example10
sort
string

List of fields to order by, and in which direction. This is a JSON object, with properties listed in desired order, with values of 1 for ascending, or -1 for descending. For example, { "value": -1, "_id": 1 }. Refer to the official documentation to learn more.

Responses
200

OK

Example 1
{
  "offset": 0,
  "logs": [
    {
      "_id": "68341684d387e3d7509267f6",
      "appId": "30d2e4bf-2402-4197-b844-e7082b07dc65",
      "method": "scheduler:registration.auto.renew.scheduler",
      "entries": [
        {
          "caller": "anonymous OR constructor -> handleScheduler",
          "severity": "debug",
          "method": "scheduler:registration.auto.renew.scheduler",
          "timestamp": "2025-05-26T07:21:40.283Z",
          "args": [
            "Job processor registration.auto.renew.scheduler is being executed..."
          ]
        },
        {
          "caller": "anonymous OR constructor -> handleScheduler",
          "severity": "debug",
          "method": "scheduler:registration.auto.renew.scheduler",
          "timestamp": "2025-05-26T07:21:40.295Z",
          "args": [
            "Job processor registration.auto.renew.scheduler was successfully executed"
          ]
        }
      ],
      "startTime": "2025-05-26T07:21:40.283Z",
      "endTime": "2025-05-26T07:21:40.295Z",
      "totalTime": 12,
      "_createdAt": "2025-05-26T07:21:40.295Z",
      "instanceId": "ad219c7b-84a5-4077-9ede-f6f9d7c4d3bd",
      "_updatedAt": "2025-05-26T07:21:40.296Z"
    },
    {
      "_id": "68340f7cd387e3d7509267f5",
      "appId": "30d2e4bf-2402-4197-b844-e7082b07dc65",
      "method": "scheduler:registration.auto.renew.scheduler",
      "entries": [
        {
          "caller": "anonymous OR constructor -> handleScheduler",
          "severity": "debug",
          "method": "scheduler:registration.auto.renew.scheduler",
          "timestamp": "2025-05-26T06:51:40.284Z",
          "args": [
            "Job processor registration.auto.renew.scheduler is being executed..."
          ]
        },
        {
          "caller": "anonymous OR constructor -> handleScheduler",
          "severity": "debug",
          "method": "scheduler:registration.auto.renew.scheduler",
          "timestamp": "2025-05-26T06:51:40.294Z",
          "args": [
            "Job processor registration.auto.renew.scheduler was successfully executed"
          ]
        }
      ],
      "startTime": "2025-05-26T06:51:40.284Z",
      "endTime": "2025-05-26T06:51:40.294Z",
      "totalTime": 10,
      "_createdAt": "2025-05-26T06:51:40.294Z",
      "instanceId": "ad219c7b-84a5-4077-9ede-f6f9d7c4d3bd",
      "_updatedAt": "2025-05-26T06:51:40.295Z"
    }
  ],
  "count": 2,
  "total": 3916,
  "success": true
}
Expand All
object
offset
integer
logs
Array of object
object
_id
string
appId
string
method
string
entries
Array of object
object
caller
string
severity
string
method
string
timestamp
string
args
Array of string
string
startTime
string
endTime
string
totalTime
integer
_createdAt
string
instanceId
string
_updatedAt
string
count
integer
total
integer
success
boolean
400

Forbidden

Permission Error
{
  "success": false,
  "error": "User does not have the permissions required for this action [error-unauthorized]"
}
object
success
boolean
error
string
401

Unauthorized

Authorization Error
{
  "status": "error",
  "message": "You must be logged in to do this."
}
object
status
string
message
string
404

Not Found

Example 1
{
  "success": false,
  "error": "No App found by the id of: :id"
}
object
success
boolean
error
string