Create Saved Filter

Create a new saved report filter with optional scheduling

POST /v2/reporting/saved

Create Saved Filter

cURL

curl --request POST \
  --url https://api.voxo.co/v2/reporting/saved/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tenantId": 1,
  "url": "<string>",
  "module": "calls",
  "name": "<string>"
}
'

200

[
  {
    "id": 123,
    "userId": 123,
    "tenantId": 123,
    "apiUrl": "<string>",
    "module": "<string>",
    "createdAt": "<string>",
    "deletedAt": "<string>",
    "name": "<string>",
    "description": "<string>",
    "scheduled": 123,
    "recipients": "<string>",
    "frequency": "<string>",
    "error": 123,
    "errorDescription": "<string>",
    "queryParams": "<unknown>",
    "postParams": "<unknown>"
  }
]

Authorizations

Authorization · string · header · required

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

Body

application/json

tenantId · number · required

Tenant ID

Required range: x > 0

url · string · required

API URL for the saved filter

module · Option 1 · enum<string> Option 2 · enum<string> Option 3 · enum<string> Option 4 · enum<string> Option 5 · enum<string> Option 6 · enum<string> Option 7 · enum<string> Option 8 · enum<string> Option 9 · enum<string> · required

Reporting module this filter belongs to

Available options: calls

name · string · required

Name of the saved filter

queryParams · object

Query parameters for the filter

Show child attributes

postParams · object

POST body parameters for the filter

Show child attributes

description · string

Description of the saved filter

scheduled · Option 1 · enum<number> Option 2 · enum<number> · default: 0

Whether this filter is scheduled (0 = no, 1 = yes)

Available options: 0

recipients · string

Comma-separated email recipients for scheduled reports

frequency · Option 1 · enum<string> Option 2 · enum<string> Option 3 · enum<string>

Schedule frequency (daily, weekly, or monthly)

Available options: daily

Response

200

application/json

Created saved filter

id · number · required

Saved filter ID

userId · number · required

User ID who created the filter

tenantId · number · required

Tenant ID

apiUrl · string · required

API URL for the filter

module · string · required

Reporting module

createdAt · string · required

Creation timestamp

deletedAt · string | null · required

Deletion timestamp

name · string · required

Filter name

description · string | null · required

Filter description

scheduled · number · required

Whether scheduled (0 or 1)

recipients · string | null · required

Email recipients

frequency · string | null · required

Schedule frequency

error · number · required

Error flag (0 or 1)

errorDescription · string | null · required

Error description

queryParams · any | null

Query parameters

postParams · any | null

POST body parameters