Parse a Query String - Virtuous API Docs

curl --request POST \ --url https://prod-api.raisedonors.com/api/Query/parse \ --header 'Authorization: <api-key>' \ --header 'Content-Type: application/json' \ --data ' { "queryString": "<string>" } '

Authorizations

Authorization

string

header

required

JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Body

The parse request, including query type and query string.

Request model for parsing a human-readable query string into a structured query.

queryType

enum<integer>

The type of query to parse the string into (for example, donor or campaign).

Available options:

0,

1,

2,

3,

4,

5,

6,

7,

8,

9

queryString

string | null

The query string to parse.

Response

200