Search activities by complex criteria

POST 
/activities/searches

GET with body payload

• no resources created: Returns all activities matching the query passed as request input payload.

Request

Query Parameters

limit string

The limit used for this page of results. This will be the same as the limit query parameter unless it exceeded the maximum value allowed for this API endpoint

offset string

The offset used for this page of results

sort string

Indicate sort by field

order string

Possible values: [ASC, DESC]

Indicate sorting direction

application/json

Body

search_criterias

object[]

required

Array [

filter_key stringrequired

search by field

operation string

Possible values: [EQ, NE, CNT, NON_CNT, BTW, IN]

operation to perform for the filter

value stringrequired

search value

]

Responses

200

OK

application/json

Schema

Schema

offset integerrequired

The offset used for this page of results.

limit integerrequired

The limit used for this page of results. This will be the same as the limit query parameter unless it exceeded the maximum value allowed for this API endpoint.

total_count integerrequired

One greater than the offset of the last item in the entire collection. The total number of items in the collection may be less than total_count.

sort string

Field to define the sort field.

order string

Possible values: [ASC, DESC]

To indicate sorting direction. Ascending or Descending.

items

object[]

required

Array [

id int64

Possible values: >= 1

created_at date-time

event_name string

object_id int64

Possible values: >= 1

object_name string

object_type string

project_id int64

Possible values: >= 1

project_name string

subject_name string

subject_type string

details

object

history

object[]

Array [

field string

old_value string

new_value string

]

]

Example (from schema)

{
  "offset": 0,
  "limit": 0,
  "total_count": 0,
  "sort": "string",
  "order": "ASC",
  "items": [
    {
      "id": 0,
      "created_at": "2024-10-07T13:47:24.592Z",
      "event_name": "string",
      "object_id": 0,
      "object_name": "string",
      "object_type": "string",
      "project_id": 0,
      "project_name": "string",
      "subject_name": "string",
      "subject_type": "string",
      "details": {
        "history": [
          {
            "field": "string",
            "old_value": "string",
            "new_value": "string"
          }
        ]
      }
    }
  ]
}

Loading...