Get all API reference logs
  • 26 Sep 2023
  • 2 Minutes to read
  • Contributors
  • Dark
    Light

Get all API reference logs

  • Dark
    Light

Article Summary

Get
/v2/APIReferences/{apiReferenceId}/Logs
Security
API Key
Header parameter nameapi_token
Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens
Path parameters
apiReferenceId
stringRequired

The ID of the API reference

Query parameters
page
integer (int32)

Page number

Default"1"
resultsPerPage
integer (int32)

Total logs per page

Default"5"
Responses
200

Success

Success status Response

This is the sample response for this endpoint. You can verify the individual logs in /v2/ApiReferences/{apiReferenceId}/Logs/{logId}.

{
  "data": [
    {
      "logs_id": "33b5c7e-fcbe-4797-b144-1a7ca2508f44",
      "user_name": "Peter Jone",
      "user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
      "title": "Import successful",
      "modified_at": "2023-09-26T06:34:59.3475867Z",
      "error_count": 12,
      "alerts_count": 34
    },
    {
      "logs_id": "5g25c7e-fcbe-4797-b144-1a7ca2843tv4",
      "user_name": "Theresa May",
      "user_id": "d71efc6f-e968-4e95-82eb-85ad6155984rf",
      "title": "Import successful",
      "modified_at": "2023-09-26T06:34:59.3475888Z",
      "error_count": 12,
      "alerts_count": 34
    }
  ],
  "extension_data": null,
  "success": false,
  "errors": [],
  "warnings": [],
  "information": []
}
Expand All
object
data
Array of object (ApiReferenceLogsDataCustomer)

API reference response data

object
logs_id
string

The API reference Log ID

user_name
string

The name of the team account

user_id
string

The ID of the team account

title
string

Status of API reference

modified_at
string (date-time)

Modified date/time

error_count
integer (int32)

Total errors count

alerts_count
integer (int32)

Total alerts count

extension_data
object (ExtensionDataObject)
success
boolean

Status indication for customer API response

errors
Array of object (BaseError)

Errors in the customer API response

object
extension_data
object (ExtensionDataObject)
stack_trace
string

Stack trace for error response message

description
string

Description for error cause

error_code
string

Error code for Api resonse

custom_data
object
warnings
Array of object (BaseWarning)

Warning in the customer API response

object
extension_data
object (ExtensionDataObject)
description
string

Warning description

warning_code
string

warning code for customer Api base response

information
Array of object (BaseInformation)

Information passed by the customer API response

object
extension_data
object (ExtensionDataObject)
description
string

status description for customer Api response information

400

Bad Request

Inalid API reference ID

Kindly ensure that the given API reference ID is valid.

{
  "data": [],
  "extension_data": null,
  "success": false,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "Api reference not found.",
      "error_code": null,
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}
Expand All
object
data
Array of object (ApiReferenceLogsDataCustomer)

API reference response data

object
logs_id
string

The API reference Log ID

user_name
string

The name of the team account

user_id
string

The ID of the team account

title
string

Status of API reference

modified_at
string (date-time)

Modified date/time

error_count
integer (int32)

Total errors count

alerts_count
integer (int32)

Total alerts count

extension_data
object (ExtensionDataObject)
success
boolean

Status indication for customer API response

errors
Array of object (BaseError)

Errors in the customer API response

object
extension_data
object (ExtensionDataObject)
stack_trace
string

Stack trace for error response message

description
string

Description for error cause

error_code
string

Error code for Api resonse

custom_data
object
warnings
Array of object (BaseWarning)

Warning in the customer API response

object
extension_data
object (ExtensionDataObject)
description
string

Warning description

warning_code
string

warning code for customer Api base response

information
Array of object (BaseInformation)

Information passed by the customer API response

object
extension_data
object (ExtensionDataObject)
description
string

status description for customer Api response information


Was this article helpful?