Admin Insights v0.3.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

The Insights API manages visual presentation of analytic results related to the financial institution’s data. By utilizing this API, administrative consumers at a financial institution can gain valuable insights into customer behavior and make informed business decisions. Insights are defined and provided by a data provider.

Insight Types are templates of visual data presentations that analysts use to create insights instances they see in the application. Insight Types are analogous to items in a tool palette. Data scientists define the Insight Types that analysts may chose from when building dashboards or reports.

An Insight Type consists of a visualType, one of chart, metric, or table. Charts offer graphical representation of data, helping users visualize patterns, trends, and correlations. Metrics provide numeric measurements, such as average funding amount or average customer age. Tables comprise of columns and rows that contain specific values.

An Insight Type also has a category, which is tells which measure the Insight corresponds to. These categories are used to determine which pre-defined dashboard the Insight shows up on. When users create their own dashboards, they can add Insights to a dashboard based on its category or ID.

Download OpenAPI Definition (YAML)

Base URLs:

• https://api.apiture.com/bankingAdmin

Terms of service

Email: Apiture Web: Apiture

License: Apiture API License

Authentication

• OpenID Connect authentication (accessToken)
  • OpenId Connect (OIDC) authentication/authorization. The client uses the authorization_endpoint and token_endpoint to obtain an access token to pass in the Authorization header. Those endpoints are available via the OIDC Configuration URL. The actual URL may vary with each financial institution. See details at Secure Access.
  • OIDC Configuration URL = https://auth.apiture.com/oidc/.well-known/openid-configuration

Insight Types

Templates Used to Create Insight Instances

listInsightTypes

Code samples

# You can also use wget
curl -X GET https://api.apiture.com/bankingAdmin/insightTypes \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.apiture.com/bankingAdmin/insightTypes HTTP/1.1
Host: api.apiture.com
Accept: application/json

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/bankingAdmin/insightTypes',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/bankingAdmin/insightTypes',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.apiture.com/bankingAdmin/insightTypes',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.apiture.com/bankingAdmin/insightTypes', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/bankingAdmin/insightTypes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.apiture.com/bankingAdmin/insightTypes", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Return a list of insight types

GET https://api.apiture.com/bankingAdmin/insightTypes

Return a collection of insight types.

Parameters

Example responses

200 Response

{
  "items": [
    {
      "id": "0399abed-fd3d",
      "label": "e-statement Enrollment",
      "description": "Percentage of customer account types enrolled in e-statements.",
      "category": {
        "id": "engagement",
        "label": "Engagement"
      },
      "tags": [
        "Efficiency",
        "Marketing"
      ],
      "filters": {
        "operator": "and",
        "primitiveFilters": [
          {
            "filterType": {
              "id": "30e5979cbb91316427a9",
              "name": "newCustomersWithin60Days"
            },
            "values": [
              "today"
            ]
          },
          {
            "filterType": {
              "id": "8f78da527d8135445136",
              "name": "customerAge"
            },
            "operator": "between",
            "values": [
              "35",
              "49"
            ]
          }
        ]
      },
      "provider": {
        "name": "domo",
        "domo": {
          "cardId": "qjRQ2",
          "pageId": "BgnKQ"
        }
      },
      "publishedAt": "2023-04-24T06:32:24.508Z"
    },
    {
      "id": "d62c0701-0d74-4836-83f9-ebf3709442ea",
      "label": "Customers",
      "description": "Customer insights let you know which customers are your highest earners, who is paying fees, and more.",
      "category": {
        "id": "retailCustomer",
        "label": "Retail Customer"
      },
      "tags": [
        "Efficiency",
        "Marketing"
      ],
      "filters": {
        "operator": "and",
        "primitiveFilters": [
          {
            "filterType": {
              "id": "30e5979cbb91316427a9",
              "name": "newCustomersWithin60Days"
            },
            "values": [
              "today"
            ]
          },
          {
            "filterType": {
              "id": "8f78da527d8135445136",
              "name": "customerAge"
            },
            "operator": "between",
            "values": [
              "35",
              "49"
            ]
          }
        ]
      },
      "provider": {
        "name": "domo",
        "domo": {
          "cardId": "qjRQ2",
          "pageId": "BgnKQ"
        }
      },
      "publishedAt": "2023-04-24T06:32:24.508Z"
    }
  ]
}

Responses

Response Schema

Status Code 400

Status Code 401

Status Code 403

Status Code 422

Status Code 429

Status Code 4XX

Status Code 5XX

getInsightType

Code samples

# You can also use wget
curl -X GET https://api.apiture.com/bankingAdmin/insightTypes/{insightTypeId} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.apiture.com/bankingAdmin/insightTypes/{insightTypeId} HTTP/1.1
Host: api.apiture.com
Accept: application/json

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/bankingAdmin/insightTypes/{insightTypeId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/bankingAdmin/insightTypes/{insightTypeId}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.apiture.com/bankingAdmin/insightTypes/{insightTypeId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.apiture.com/bankingAdmin/insightTypes/{insightTypeId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/bankingAdmin/insightTypes/{insightTypeId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.apiture.com/bankingAdmin/insightTypes/{insightTypeId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Fetch a representation of this insight type

GET https://api.apiture.com/bankingAdmin/insightTypes/{insightTypeId}

Return the JSON representation of this insight type resource.

Parameters

Example responses

200 Response

{
  "id": "0399abed-fd3d",
  "label": "e-statement Enrollment",
  "description": "Percentage of customer account types enrolled in e-statements.",
  "category": {
    "id": "engagement",
    "label": "Engagement"
  },
  "tags": [
    "Efficiency",
    "Marketing"
  ],
  "provider": {
    "name": "domo",
    "domo": {
      "cardId": "qjRQ2",
      "pageId": "BgnKQ"
    }
  },
  "publishedAt": "2023-04-24T06:32:24.508Z"
}

Responses

Response Schema

Status Code 400

Status Code 401

Status Code 403

Status Code 429

Status Code 4XX

Status Code 5XX

getRecommendedInsightTypes

Code samples

# You can also use wget
curl -X GET https://api.apiture.com/bankingAdmin/recommendedInsightTypes \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.apiture.com/bankingAdmin/recommendedInsightTypes HTTP/1.1
Host: api.apiture.com
Accept: application/json

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/bankingAdmin/recommendedInsightTypes',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/bankingAdmin/recommendedInsightTypes',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.apiture.com/bankingAdmin/recommendedInsightTypes',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.apiture.com/bankingAdmin/recommendedInsightTypes', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/bankingAdmin/recommendedInsightTypes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.apiture.com/bankingAdmin/recommendedInsightTypes", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Fetch a representation of the recommended insight types

GET https://api.apiture.com/bankingAdmin/recommendedInsightTypes

Returns insights based on current users preferred topics. These are matched using the Insight's topicType.

Example responses

200 Response

{
  "items": [
    {
      "id": "0399abed-fd3d",
      "label": "e-statement Enrollment",
      "description": "Percentage of customer account types enrolled in e-statements.",
      "category": {
        "id": "engagement",
        "label": "Engagement"
      },
      "tags": [
        "Efficiency",
        "Marketing"
      ],
      "filters": {
        "operator": "and",
        "primitiveFilters": [
          {
            "filterType": {
              "id": "30e5979cbb91316427a9",
              "name": "newCustomersWithin60Days"
            },
            "values": [
              "today"
            ]
          },
          {
            "filterType": {
              "id": "8f78da527d8135445136",
              "name": "customerAge"
            },
            "operator": "between",
            "values": [
              "35",
              "49"
            ]
          }
        ]
      },
      "provider": {
        "name": "domo",
        "domo": {
          "cardId": "qjRQ2",
          "pageId": "BgnKQ"
        }
      },
      "publishedAt": "2023-04-24T06:32:24.508Z"
    },
    {
      "id": "d62c0701-0d74-4836-83f9-ebf3709442ea",
      "label": "Customers",
      "description": "Customer insights let you know which customers are your highest earners, who is paying fees, and more.",
      "category": {
        "id": "retailCustomer",
        "label": "Retail Customer"
      },
      "tags": [
        "Efficiency",
        "Marketing"
      ],
      "filters": {
        "operator": "and",
        "primitiveFilters": [
          {
            "filterType": {
              "id": "30e5979cbb91316427a9",
              "name": "newCustomersWithin60Days"
            },
            "values": [
              "today"
            ]
          },
          {
            "filterType": {
              "id": "8f78da527d8135445136",
              "name": "customerAge"
            },
            "operator": "between",
            "values": [
              "35",
              "49"
            ]
          }
        ]
      },
      "provider": {
        "name": "domo",
        "domo": {
          "cardId": "qjRQ2",
          "pageId": "BgnKQ"
        }
      },
      "publishedAt": "2023-04-24T06:32:24.508Z"
    }
  ]
}

Responses

Response Schema

Status Code 401

Status Code 403

Status Code 429

Status Code 4XX

Status Code 5XX

Insights

Visual Presentations of Banking Analytics

getInsightVisual

Code samples

# You can also use wget
curl -X POST https://api.apiture.com/bankingAdmin/insightVisuals \
  -H 'Content-Type: application/merge-patch+json' \
  -H 'Accept: text/html' \
  -H 'Authorization: Bearer {access-token}'

POST https://api.apiture.com/bankingAdmin/insightVisuals HTTP/1.1
Host: api.apiture.com
Content-Type: application/merge-patch+json
Accept: text/html

const fetch = require('node-fetch');
const inputBody = '{
  "id": "string",
  "type": "metric",
  "filters": {
    "operator": "or",
    "primitiveFilters": [
      {
        "filterType": {
          "id": "215eaed841368ce154d5",
          "name": "customerType"
        },
        "operator": "equals",
        "values": [
          "retail"
        ]
      },
      {
        "filterType": {
          "id": "6b3927745edec398ad74",
          "name": "customerAge"
        },
        "operator": "between",
        "values": [
          "35",
          "49"
        ]
      }
    ],
    "compositeFilters": [
      {
        "operator": "and",
        "primitiveFilters": [
          {
            "filterType": "[Object]",
            "operator": "in",
            "values": "[Object]"
          },
          {
            "filterType": "[Object]",
            "operator": "greaterThan",
            "values": "[Object]"
          }
        ]
      }
    ]
  }
}';
const headers = {
  'Content-Type':'application/merge-patch+json',
  'Accept':'text/html',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/bankingAdmin/insightVisuals',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Content-Type':'application/merge-patch+json',
  'Accept':'text/html',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/bankingAdmin/insightVisuals',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/merge-patch+json',
  'Accept' => 'text/html',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://api.apiture.com/bankingAdmin/insightVisuals',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/merge-patch+json',
  'Accept': 'text/html',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.apiture.com/bankingAdmin/insightVisuals', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/bankingAdmin/insightVisuals");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/merge-patch+json"},
        "Accept": []string{"text/html"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://api.apiture.com/bankingAdmin/insightVisuals", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Fetch a visual representation of an insight

POST https://api.apiture.com/bankingAdmin/insightVisuals

Fetch a visual representation of an insight using the data provider. This operation is idempotent: an insight visual will not change unless it is changed in the data provider.

Body parameter

{
  "id": "string",
  "type": "metric",
  "filters": {
    "operator": "or",
    "primitiveFilters": [
      {
        "filterType": {
          "id": "215eaed841368ce154d5",
          "name": "customerType"
        },
        "operator": "equals",
        "values": [
          "retail"
        ]
      },
      {
        "filterType": {
          "id": "6b3927745edec398ad74",
          "name": "customerAge"
        },
        "operator": "between",
        "values": [
          "35",
          "49"
        ]
      }
    ],
    "compositeFilters": [
      {
        "operator": "and",
        "primitiveFilters": [
          {
            "filterType": "[Object]",
            "operator": "in",
            "values": "[Object]"
          },
          {
            "filterType": "[Object]",
            "operator": "greaterThan",
            "values": "[Object]"
          }
        ]
      }
    ]
  }
}

Parameters

Example responses

200 Response

"string"

400 Response

{
  "id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
  "type": "https://production.api.apiture.com/errors/badRequest/v1.0.0",
  "title": "Bad Request",
  "status": 400,
  "occurredAt": "2022-04-25T12:42:21.375Z",
  "detail": "Input did not parse as JSON",
  "instance": "https://production.api.apiture.com/banking/transfers/bb709151-575041fcd617"
}

Responses

Response Schema

Status Code 400

Status Code 401

Status Code 403

Status Code 429

Status Code 4XX

Status Code 5XX

Schemas

analyticFilterOperatorType

"equals"

Analytic Filter Operator Type (v1.0.0)

Indicates the type of the comparison operator used by an analytic filter.

analyticFilterOperatorType strings may have one of the following enumerated values:

type: string

enum values: equals, notEquals, lessThan, lessThanOrEqualTo, greaterThan, greaterThanOrEqualTo, before, after, between, notBetween, in, notIn

analyticFilterTypeName

"string"

Analytic Filter Type Name (v1.0.2)

The name of an analytic filter type.

type: string(text)

format: text
minLength: 2
maxLength: 100

analyticFilterTypeReference

{
  "id": "3752cfec9b06fae15c9e",
  "name": "customerAge"
}

Analytic Filter Type Reference (v1.0.2)

An object that reference and Analytic Filter Type by its id and name.

Properties

analyticFilterValue

"25-to-49"

Analytic Filter Value (v1.0.0)

A constant value used in a filter, such as 25 in a filter { customerAge greater than 25 }. This value is compared to the measure defined by the filter.

type: string(text)

format: text
maxLength: 200

apiProblem

{
  "id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
  "type": "https://production.api.apiture.com/errors/accountNotFound/v1.0.0",
  "title": "Account Not Found",
  "status": 422,
  "occurredAt": "2022-04-25T12:42:21.375Z",
  "detail": "No account exists at the given account_url",
  "instance": "https://production.api.apiture.com/banking/transfers/bb709151-575041fcd617"
}

API Problem (v1.2.1)

API problem or error, as per RFC 7807 application/problem+json.

Properties

challengeFactor

{
  "type": "sms",
  "labels": [
    "9876"
  ]
}

Challenge Factor (v1.2.1)

An challenge factor. See requiredIdentityChallenge for multiple examples.

Properties

challengeFactorId

"string"

Challenge Factor ID (v1.0.0)

The ID of an a challenge factor. This ID is unique within the factors offered with a challenge.

type: string

minLength: 3
maxLength: 48
pattern: "^[-a-zA-Z0-9$_]{3,48}$"

challengeFactorType

"sms"

Challenge Factor Type (v1.0.0)

The name of challenge factor.

challengeFactorType strings may have one of the following enumerated values:

type: string

enum values: sms, email, voice, securityQuestions, authenticatorToken

challengeOperationId

"string"

Challenge Operation ID (v1.0.1)

The ID of an operation/action for which the user must verify their identity via an identity challenge. This is passed when starting a challenge factor or when validating the identity challenge responses.

type: string

minLength: 6
maxLength: 48
pattern: "^[-a-zA-Z0-9$_]{6,48}$"

challengePromptId

"string"

Challenge Prompt ID (v1.0.0)

The unique ID of a prompt (such as a security question) in a challenge factor.

type: string

minLength: 1
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]+$"

challengeSecurityQuestion

{
  "id": "74699fa628911e762ea5",
  "prompt": "What is your mother's maiden name?"
}

Challenge Security Question (v1.0.1)

A single security question within the questions array of the challengeSecurityQuestions

Properties

challengeSecurityQuestions

{
  "questions": [
    {
      "id": "q1",
      "prompt": "What is your mother's maiden name?"
    },
    {
      "id": "q4",
      "prompt": "What is your high school's name?"
    },
    {
      "id": "q9",
      "prompt": "What is the name of your first pet?"
    }
  ]
}

Challenge Security Questions (v1.0.1)

Describes a securityQuestions challenge. This is omitted if the challenge type is not securityQuestions.

Properties

compositeAnalyticFilter

{
  "operator": "or",
  "primitiveFilters": [
    {
      "filterType": {
        "id": "215eaed841368ce154d5",
        "name": "customerType"
      },
      "operator": "equals",
      "values": [
        "retail"
      ]
    },
    {
      "filterType": {
        "id": "6b3927745edec398ad74",
        "name": "customerAge"
      },
      "operator": "between",
      "values": [
        "35",
        "49"
      ]
    }
  ],
  "compositeFilters": [
    {
      "operator": "and",
      "primitiveFilters": [
        {
          "filterType": {
            "name": "customerRegion",
            "id": "01888d58e2424bf1c676"
          },
          "operator": "in",
          "values": [
            "NC",
            "SC",
            "GA",
            "FL"
          ]
        },
        {
          "filterType": {
            "name": "accountBalance",
            "id": "023cd8af6a9d46eec506"
          },
          "operator": "greaterThan",
          "values": [
            "250000.00"
          ]
        }
      ]
    }
  ]
}

Composite Analytic Filter (v1.0.2)

A composite of analytic filter that are combined with a logical operator (and, or, not). For example, if primitiveFilters contains 3 filters p1, p2 and p2 and compositeFilters contains 2 filters c1, c2 and operator is and, the filter represents the expression ( p1 and p2 and p3 and c1 and c2 ). The example is equivalent to

( { customerType equals "retail" } or { customerAge between ["35", "49"] } or ( { customerRegion in [ "NC", "SC", "GA", "FL" ]} and { balance greaterThan "250000.00" } ) )

Note: there must be at least one item either the primitiveFilters array or the compositeFilters array.

Properties

compositeFilterOperator

"and"

Composite Filter Operator (v1.0.0)

An operator for combining filters in a composite filter.

compositeFilterOperator strings may have one of the following enumerated values:

type: string

enum values: and, or, not

insightType

{
  "id": "0399abed-fd3d",
  "label": "e-statement Enrollment",
  "description": "Percentage of customer account types enrolled in e-statements.",
  "category": {
    "id": "engagement",
    "label": "Engagement"
  },
  "tags": [
    "Efficiency",
    "Marketing"
  ],
  "provider": {
    "name": "domo",
    "domo": {
      "cardId": "qjRQ2",
      "pageId": "BgnKQ"
    }
  },
  "publishedAt": "2023-04-24T06:32:24.508Z"
}

Insight Type (v1.0.0)

An insight type stores the metadata needed to retrieve data and provide information for insights of that type.

Properties

insightTypeCategoryReference

{
  "id": "string",
  "label": "string"
}

Insight Type Category Reference (v1.0.0)

The category of data that the insight type contains. Categories are durable and do not change over time.

Properties

insightTypeItem

{
  "id": "0399abed-fd3d",
  "label": "e-statement Enrollment",
  "description": "Percentage of customer account types enrolled in e-statements",
  "category": {
    "id": "retailCustomer",
    "label": "Retail Customer"
  },
  "tags": [
    "Efficiency",
    "Marketing"
  ],
  "provider": {
    "name": "domo",
    "domo": {
      "cardId": "qjRQ2",
      "pageId": "BgnKQ"
    }
  },
  "publishedAt": "2023-04-24T06:32:24.508Z"
}

Insight Type Item (v1.0.0)

Summary representation of an insight type resource in the insight types collections. To fetch the full representation of the insightType, use the getInsightType operation, passing this item's id field as the insightTypeId path parameter.

Properties

insightTypes

{
  "items": [
    {
      "id": "0399abed-fd3d",
      "label": "e-statement Enrollment",
      "description": "Percentage of customer account types enrolled in e-statements.",
      "category": {
        "id": "engagement",
        "label": "Engagement"
      },
      "tags": [
        "Efficiency",
        "Marketing"
      ],
      "filters": {
        "operator": "and",
        "primitiveFilters": [
          {
            "filterType": {
              "id": "30e5979cbb91316427a9",
              "name": "newCustomersWithin60Days"
            },
            "values": [
              "today"
            ]
          },
          {
            "filterType": {
              "id": "8f78da527d8135445136",
              "name": "customerAge"
            },
            "operator": "between",
            "values": [
              "35",
              "49"
            ]
          }
        ]
      },
      "provider": {
        "name": "domo",
        "domo": {
          "cardId": "qjRQ2",
          "pageId": "BgnKQ"
        }
      },
      "publishedAt": "2023-04-24T06:32:24.508Z"
    },
    {
      "id": "d62c0701-0d74-4836-83f9-ebf3709442ea",
      "label": "Customers",
      "description": "Customer insights let you know which customers are your highest earners, who is paying fees, and more.",
      "category": {
        "id": "retailCustomer",
        "label": "Retail Customer"
      },
      "tags": [
        "Efficiency",
        "Marketing"
      ],
      "filters": {
        "operator": "and",
        "primitiveFilters": [
          {
            "filterType": {
              "id": "30e5979cbb91316427a9",
              "name": "newCustomersWithin60Days"
            },
            "values": [
              "today"
            ]
          },
          {
            "filterType": {
              "id": "8f78da527d8135445136",
              "name": "customerAge"
            },
            "operator": "between",
            "values": [
              "35",
              "49"
            ]
          }
        ]
      },
      "provider": {
        "name": "domo",
        "domo": {
          "cardId": "qjRQ2",
          "pageId": "BgnKQ"
        }
      },
      "publishedAt": "2023-04-24T06:32:24.508Z"
    }
  ]
}

Insight Type Collection (v1.0.0)

Collection of insight types. The items in the collection are ordered in the items array.

Properties

insightVisualParameters

{
  "id": "string",
  "type": "metric",
  "filters": {
    "operator": "or",
    "primitiveFilters": [
      {
        "filterType": {
          "id": "215eaed841368ce154d5",
          "name": "customerType"
        },
        "operator": "equals",
        "values": [
          "retail"
        ]
      },
      {
        "filterType": {
          "id": "6b3927745edec398ad74",
          "name": "customerAge"
        },
        "operator": "between",
        "values": [
          "35",
          "49"
        ]
      }
    ],
    "compositeFilters": [
      {
        "operator": "and",
        "primitiveFilters": [
          {
            "filterType": "[Object]",
            "operator": "in",
            "values": "[Object]"
          },
          {
            "filterType": "[Object]",
            "operator": "greaterThan",
            "values": "[Object]"
          }
        ]
      }
    ]
  }
}

Insight Visual Parameters (v1.0.0)

The parameters to retrieve an insight visual.

Properties

insightVisualType

"metric"

Insight Visual Type (v1.0.0)

The visual presentation type of the insight type.

insightVisualType strings may have one of the following enumerated values:

type: string

enum values: metric, chart, table

primitiveAnalyticFilter

{
  "filterType": {
    "id": "6b3927745edec398ad74",
    "name": "customerAge"
  },
  "operator": "between",
  "values": [
    "35",
    "49"
  ]
}

Primitive Analytic Filter (v1.0.2)

A primitive analytic filter that compares constant values to a data measurement within an audience data measure and returns a boolean value.

Properties

problemResponse

{
  "id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
  "type": "https://production.api.apiture.com/errors/noSuchAccount/v1.0.0",
  "title": "Account Not Found",
  "status": 422,
  "occurredAt": "2022-04-25T12:42:21.375Z",
  "detail": "No account exists for the given account reference",
  "instance": "https://production.api.apiture.com/banking/transfers/bb709151-575041fcd617"
}

Problem Response (v0.4.1)

API problem or error response, as per RFC 9457 application/problem+json.

Properties

readOnlyResourceId

"string"

Read-only Resource Identifier (v1.0.1)

The unique, opaque system-assigned identifier for a resource. This case-sensitive ID is also used in URLs as path parameters or in other properties or parameters that reference a resource by ID rather than URL. Resource IDs are immutable.

type: string

read-only
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

readOnlyTimestamp

"2021-10-30T19:06:04.250Z"

Read-Only Timestamp (v1.0.0)

A readonly or derived timestamp (an instant in time) formatted in RFC 3339 date-time UTC format: YYYY-MM-DDThh:mm:ss.sssZ.

type: string(date-time)

read-only
format: date-time
minLength: 20
maxLength: 30

requiredIdentityChallenge

{
  "operationId": "createTransfer",
  "challengeId": "0504076c566a3cf7009c",
  "factors": [
    {
      "type": "sms",
      "labels": [
        "9876"
      ],
      "id": "85c0ee5753fcd0b0953f"
    },
    {
      "type": "voice",
      "labels": [
        "9876"
      ],
      "id": "d089e10a80a8627df37b"
    },
    {
      "type": "voice",
      "labels": [
        "6754"
      ],
      "id": "10506ecf9d1c2ee00403"
    },
    {
      "type": "email",
      "labels": [
        "an****nk@example.com",
        "an****98@example.com"
      ],
      "id": "e917d671cb2f030b56f1"
    },
    {
      "type": "authenticatorToken",
      "labels": [
        "Acme fob"
      ],
      "id": "fe6c452d7da0bbb4e407"
    },
    {
      "type": "securityQuestions",
      "securityQuestions": {
        "questions": [
          {
            "id": "q1",
            "prompt": "What is your mother's maiden name?"
          },
          {
            "id": "q4",
            "prompt": "What is your high school's name?"
          },
          {
            "id": "q9",
            "prompt": "What is the name of your first pet?"
          }
        ]
      },
      "id": "df33c6f88a37d6b3f0a6"
    }
  ]
}

Required Challenge (v1.2.3)

A request from the service for the user to verify their identity. This contains a challenge ID, the corresponding operation ID, and a list of challenge factors for identity verification. The user must complete one of these challenge factors to satisfy the challenge. This schema defines the attributes in the 401 Unauthorized problem response when the 401 problem type name is challengeRequired. See the "Challenge API" for details.

Properties

resourceId

"string"

Resource Identifier (v1.0.1)

The unique, opaque system identifier for a resource. This case-sensitive ID is also used as path parameters in URLs or in other properties or parameters that reference a resource by ID rather than URL.

type: string

minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

tag

"string"

Tag (v1.0.0)

A string used as a resource tag.

type: string(text)

format: text
minLength: 1
maxLength: 36

tagsArray

[
  "retail",
  "customers"
]

Tags Array (v1.0.0)

An array of tags attached to a resource.

tagsArray is an array schema.

Array Elements

type: array: [tag]

maxItems: 64