Skip to main content
GET
/
anomalies
/
v3
/
ad
/
library
List anomalies
curl --request GET \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/anomalies/v3/ad/library \
  --header 'Authorization: Bearer <token>' \
  --header 'x-session-token: <x-session-token>'
{
  "data": [
    {
      "id": 1,
      "title": "Anomaly title",
      "description": "Anomaly description",
      "risk": 1,
      "resolutionDelay": "P7D",
      "subCategory": {
        "id": 1,
        "name": "at the office"
      },
      "category": {
        "id": 1,
        "name": "brands"
      },
      "deletedAt": "2024-01-15T08:45:00.000Z",
      "updatedAt": "2024-12-05T14:56:23.000Z",
      "createdAt": "2024-01-15T08:45:00.000Z",
      "updatableFields": {
        "title": true,
        "description": true,
        "risk": true,
        "resolutionDelay": true,
        "subCategoryId": true,
        "categoryId": true
      },
      "actions": {
        "canBeUpdated": true,
        "canBeDeleted": true
      }
    }
  ],
  "totalCount": 100,
  "pagination": {
    "page": 1,
    "pageSize": 50
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-session-token
string
required

Session token used for authenticating the request.

Example:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIxMjM0NTY3ODkwIiwic2Vzc2lvbklkIjoiYWJjZGVmMTIzNDU2IiwiaWF0IjoxNjA1MDk3ODk5LCJleHAiOjE2MDUxODQyOTl9.4XRQ1iXDyvEj5LgPZHbmTmzOZs98M3YPOzgf3MhxjaI"

Query Parameters

​
extend
enum<string>[]

Extend options:

  • "updatable-fields": Get information about the field that can be updated

  • "actions-info": Give information about actions that can be done on anomalies

Available options:
updatable-fields,
actions-info
​
whereTitle
string

Filter by title

Example:

"string"

​
whereDescription
string

Filter by description

Example:

"string"

​
whereRisk
integer[]

Filter by risk

Required range: -9007199254740991 <= x <= 9007199254740991
Example:
[1, 2, 3]
​
whereResolutionDelay
string

Filter by resolution delay

Example:

"string"

​
whereCategoryId
integer

Filter by category ID

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

1

​
whereCategoryName
string

Filter by category name

Example:

"string"

​
whereSubCategoryId
integer

Filter by sub-category ID

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

1

​
whereSubCategoryName
string

Filter by sub-category name

Example:

"string"

​
whereDeleted
boolean

Filter by deletedAt flag

Example:

true

​
whereCreatedAt
object

Filter by createdAt

Example:
{
  "start": "2021-01-01T00:00:00.000Z",
  "end": "2021-12-31T23:59:59.999Z"
}
​
whereCreatedById
integer

Filter by creator user ID

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

1

​
whereCreatedByName
string

Filter by creator user name

Example:

"string"

​
whereText
string

Filter by text

Example:

"string"

​
orderBy
object[]
​
includeCount
boolean
default:false

Include total count in response.

Example:

true

​
page
integer
default:1

Page number.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

1

​
pageSize
integer
default:50

Page size.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

50

​
findId
integer

Get the page where the item with this id is located.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

1

​
subPageSize
integer
default:10

Sub page size for grouping items.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

10

Response

List of anomalies (JSON or CSV)

​
data
object[]
required
​
totalCount
integer

Total count of items.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

100

​
pagination
object

Pagination information.