/v1/history/change

get https://api.birddogsecurity.com/v1/history/change

Retrieves a list of change history records with optional filtering by historyType

Responses

Response body

object

recordCount

integer

The total number of records available.

currentPage

integer

The current page number.

totalPages

integer

The total number of pages.

pageLimit

integer

The limit of records per page.

results

array of objects

results

object

customerId

integer

The ID of the customer.

customerName

string

The name of the customer.

scanDayEntered

date

The scan day when the change was entered.

recordType

string

The type of the record (e.g., asset, exposure).

changeType

string

The type of change (e.g., addition, update).

historyType

string

The type of history associated with the change (e.g., asset, exposure).

assetLabel

string

The label for the asset history.

exposureLabel

string

The label for the exposure history.

historyDescription

string

Description of the change history.

typeDescription

string

Description of the type of the change.

historyMetadata

object

Metadata associated with the history change.

Has additional fields

assetId

string

The asset ID associated with the history change.

exposureId

string

The exposure ID associated with the history change.

assetTagMetadata

string

Metadata tags for the asset.

Language

Credentials

Header


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.birddogsecurity.com/v1/history/change \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A paginated list of change history records.

401Unauthorized: API key is missing or invalid.

500Database error occurred.