Get all API reference logs
- 02 Nov 2024
- 2 Minutes To Read
- Contributors
- Print
- Dark modeLight
- PDF
Get all API reference logs
- Updated On 02 Nov 2024
- 2 Minutes To Read
- Contributors
- Print
- Dark modeLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
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
Default1
resultsPerPage
integer (int32)
Total logs per page
Default5
Responses
200
Success
Success status Response
This is the sample response for this endpoint. You can verify the individual logs in /v2/ApiReferences//Logs/.
{
"data": [
{
"logs_id": "33b5c7e-fcbe-4797-b144-1a7ca2508f44",
"user_name": "Peter Jone",
"user_id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
"title": "Import successful",
"modified_at": "2024-06-13T02:30:00Z",
"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": "2024-06-13T02:30:00Z",
"error_count": 12,
"alerts_count": 34
}
],
"extension_data": null,
"success": false,
"errors": [],
"warnings": [],
"information": []
}object
data
Array of object (ApiReferenceLogsDataCustomer) | null
API reference response data
object
logs_id
string | null
The API reference Log ID
user_name
string | null
The name of the team account
user_id
string | null
The ID of the team account
title
string | null
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 | null
Extention data for customer API response
success
boolean
Status indication for customer API response
errors
Array of object (BaseError) | null
Errors in the customer API response
object
extension_data
object | null
Thids is the Extention data object
stack_trace
string | null
Stack trace for error response message
description
string | null
Description for error cause
error_code
string | null
Error code for Api response
custom_data
object | null
property*
warnings
Array of object (BaseWarning) | null
Warnings in the customer API response
object
extension_data
object | null
Extention Data for customer Api warning
description
string | null
Warning description
warning_code
string | null
warning code for customer Api base response
information
Array of object (BaseInformation) | null
Information passed by the customer API response
object
extension_data
object | null
Extention data for customer Api response information
description
string | null
status description for customer Api response information
400
Bad Request
Inalid API reference ID
Kindly ensure that the given API reference ID is valid.
{
"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": []
}object
extension_data
object | null
Extention data for customer API response
success
boolean
Status indication for customer API response
errors
Array of object (BaseError) | null
Errors in the customer API response
object
extension_data
object | null
Thids is the Extention data object
stack_trace
string | null
Stack trace for error response message
description
string | null
Description for error cause
error_code
string | null
Error code for Api response
custom_data
object | null
property*
warnings
Array of object (BaseWarning) | null
Warnings in the customer API response
object
extension_data
object | null
Extention Data for customer Api warning
description
string | null
Warning description
warning_code
string | null
warning code for customer Api base response
information
Array of object (BaseInformation) | null
Information passed by the customer API response
object
extension_data
object | null
Extention data for customer Api response information
description
string | null
status description for customer Api response information
Was this article helpful?
