Skip to main content

insightQuery

idstring<uuid>
queryGroupstring
labelstring
versionstring
aliases object
property name*string
metricsInsightMetric (string)[]

Possible values: [account:balance:sum, account:balance:min, account:balance:max, account:balance:range, account:balance:oldest, account:balance:latest, account:balance:average, account:transaction:count, account:transaction:amount:sum, account:transaction:amount:min, account:transaction:amount:max, account:transaction:amount:range, account:transaction:amount:oldest, account:transaction:amount:latest, account:transaction:amount:average, account:transaction:amount:average:day, account:transaction:amount:average:week, account:transaction:amount:average:month, account:transaction:amount:average:year, account:transaction:created:range:day, account:transaction:created:range:week, account:transaction:created:range:month, account:transaction:created:range:year, account:transaction:created:oldest, account:transaction:created:latest, charity:account:transaction:amount:sum]

dimensionsInsightDimension (string)[]

Possible values: [account:id, account:name, account:nickname, account:number, account:type, account:subtype, account:currency, account:balance, account:transaction:id, account:transaction:amount, account:transaction:external_id, account:transaction:status, account:transaction:type, account:transaction:subtype, account:transaction:description, account:transaction:code, account:transaction:created, account:transaction:created:date, account:transaction:created:day, account:transaction:created:week, account:transaction:created:month, account:transaction:created:year, account:transaction:currency, account:transaction:third-party:name, account:transaction:business:category, account:transaction:business:subcategory, account:transaction:budget:category, account:transaction:budget:subcategory, account:transaction:frequency, charity:account:id, charity:account:name, charity:account:source, charity:account:medium, charity:account:campaign, charity:account:term, charity:account:content, charity:account:start, charity:account:expire, charity:account:transaction:id, charity:account:transaction:external_id, charity:account:transaction:created, charity:account:transaction:created:date, charity:account:transaction:created:day, charity:account:transaction:created:week, charity:account:transaction:created:month, charity:account:transaction:created:year, charity:account:transaction:currency, charity:account:transaction:status, charity:account:transaction:customer:email, charity:account:transaction:customer:first_name, charity:account:transaction:customer:last_name, charity:account:transaction:customer:birthdate, charity:account:transaction:customer:address:street, charity:account:transaction:customer:address:locality, charity:account:transaction:customer:address:region, charity:account:transaction:customer:address:country, charity:account:transaction:customer:address:postal_code, charity:account:transaction:customer:contact, charity:account:transaction:customer:phone]

metricFilterClauses object[]
  • Array [
  • filters object[]
  • Array [
  • metricInsightMetricField (string)

    Possible values: [account:balance, account:balance:sum, account:balance:range, account:transaction:amount, account:transaction:amount:sum, account:transaction:amount:range, charity:account:transaction:amount]

    operatorOperator (string)

    Possible values: [BETWEEN, GREATER_THAN, LESS_THAN, NOT_EQUALS, EQUALS]

    valuenumber
    maxnumber
    minnumber
  • ]
  • ]
  • dimensionFilterClauses object[]
  • Array [
  • filters object[]
  • Array [
  • dimensionInsightDimension (string)

    Possible values: [account:id, account:name, account:nickname, account:number, account:type, account:subtype, account:currency, account:balance, account:transaction:id, account:transaction:amount, account:transaction:external_id, account:transaction:status, account:transaction:type, account:transaction:subtype, account:transaction:description, account:transaction:code, account:transaction:created, account:transaction:created:date, account:transaction:created:day, account:transaction:created:week, account:transaction:created:month, account:transaction:created:year, account:transaction:currency, account:transaction:third-party:name, account:transaction:business:category, account:transaction:business:subcategory, account:transaction:budget:category, account:transaction:budget:subcategory, account:transaction:frequency, charity:account:id, charity:account:name, charity:account:source, charity:account:medium, charity:account:campaign, charity:account:term, charity:account:content, charity:account:start, charity:account:expire, charity:account:transaction:id, charity:account:transaction:external_id, charity:account:transaction:created, charity:account:transaction:created:date, charity:account:transaction:created:day, charity:account:transaction:created:week, charity:account:transaction:created:month, charity:account:transaction:created:year, charity:account:transaction:currency, charity:account:transaction:status, charity:account:transaction:customer:email, charity:account:transaction:customer:first_name, charity:account:transaction:customer:last_name, charity:account:transaction:customer:birthdate, charity:account:transaction:customer:address:street, charity:account:transaction:customer:address:locality, charity:account:transaction:customer:address:region, charity:account:transaction:customer:address:country, charity:account:transaction:customer:address:postal_code, charity:account:transaction:customer:contact, charity:account:transaction:customer:phone]

    operatorOperator (string)

    Possible values: [BETWEEN, GREATER_THAN, LESS_THAN, NOT_EQUALS, EQUALS]

    valuestring
    maxstring
    minstring
    quantityinteger
    quantityDemarcationDemarcation (string)

    Possible values: [DAY, WEEK, MONTH, YEAR]

    offsetinteger
    offsetDemarcationDemarcation (string)

    Possible values: [DAY, WEEK, MONTH, YEAR]

  • ]
  • ]
  • orderBy object[]
  • Array [
  • fieldInsightDimension (string)

    Possible values: [account:id, account:name, account:nickname, account:number, account:type, account:subtype, account:currency, account:balance, account:transaction:id, account:transaction:amount, account:transaction:external_id, account:transaction:status, account:transaction:type, account:transaction:subtype, account:transaction:description, account:transaction:code, account:transaction:created, account:transaction:created:date, account:transaction:created:day, account:transaction:created:week, account:transaction:created:month, account:transaction:created:year, account:transaction:currency, account:transaction:third-party:name, account:transaction:business:category, account:transaction:business:subcategory, account:transaction:budget:category, account:transaction:budget:subcategory, account:transaction:frequency, charity:account:id, charity:account:name, charity:account:source, charity:account:medium, charity:account:campaign, charity:account:term, charity:account:content, charity:account:start, charity:account:expire, charity:account:transaction:id, charity:account:transaction:external_id, charity:account:transaction:created, charity:account:transaction:created:date, charity:account:transaction:created:day, charity:account:transaction:created:week, charity:account:transaction:created:month, charity:account:transaction:created:year, charity:account:transaction:currency, charity:account:transaction:status, charity:account:transaction:customer:email, charity:account:transaction:customer:first_name, charity:account:transaction:customer:last_name, charity:account:transaction:customer:birthdate, charity:account:transaction:customer:address:street, charity:account:transaction:customer:address:locality, charity:account:transaction:customer:address:region, charity:account:transaction:customer:address:country, charity:account:transaction:customer:address:postal_code, charity:account:transaction:customer:contact, charity:account:transaction:customer:phone]

    sortSort (string)

    Possible values: [ASC, DESC]

  • ]
  • limitnumber
    pagenumber
    insightQuery
    {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "queryGroup": "string",
    "label": "string",
    "version": "string",
    "aliases": {},
    "metrics": [
    "account:balance:sum"
    ],
    "dimensions": [
    "account:id"
    ],
    "metricFilterClauses": [
    {
    "filters": [
    {
    "metric": "account:balance",
    "operator": "BETWEEN",
    "value": 0,
    "max": 0,
    "min": 0
    }
    ]
    }
    ],
    "dimensionFilterClauses": [
    {
    "filters": [
    {
    "dimension": "account:id",
    "operator": "BETWEEN",
    "value": "string",
    "max": "string",
    "min": "string",
    "quantity": 0,
    "quantityDemarcation": "DAY",
    "offset": 0,
    "offsetDemarcation": "DAY"
    }
    ]
    }
    ],
    "orderBy": [
    {
    "field": "account:id",
    "sort": "ASC"
    }
    ],
    "limit": 0,
    "page": 0
    }