Summary Metrics

Overview

Highnote provides summary metrics for applications and transactions that empower you with essential data to drive your critical business decisions. You can retrieve summary metrics from the Highnote Dashboard or using the Highnote API.

Data freshness

Note the following about Highnote’s summary metrics API’s data freshness rules:

• Summary metrics data is available within one hour, on the hour. For example, if you request data at 2:45PM, the API will return data up to 1 PM.
• The summary metrics API provides a data freshness timestamp in the results field.
• The default sorting of summary metrics results is descending.

Get application metrics

Application metrics show account holder and authorized user application data across card products. You can use the cardProductApplicationBusinessMetric query to retrieve the following data:

Data type	Description
timeRange	Requested start and end timestamp
asOf	Data freshness timestamp
createdApplications	New applications that have been submitted
approvedApplications	Applications that have been approved. Once an application has been approved, a financial account can be used to the account holder
deniedApplications	Applications that have failed one or more card product policies. When an application is denied, a payment card cannot be issued to the account holder. Customer notification of the denial and denial reason may be required
inReviewApplications	Applications may be flagged for manual review because fraud is suspected or the information provided appears incorrect. This status indicates a Highnote agent is reviewing the application to determine a decision or if additional information is required from the account holder
pendingApplications	Applications that have been received, and are being verified by the system
closedApplications	Applications that have been processed or withdrawn

Use the following query to retrieve application metrics:

CardProductApplicationBusinessMetric

Query

query cardProductApplicationBusinessMetric(
  $input: CardProductApplicationBusinessMetricFilterInput
) {
  cardProductApplicationBusinessMetric(filterBy: $input) {
    __typename
    ... on CardProductApplicationBusinessMetricResult {
      timeRange {
        start
        end
      }
      asOf
      cardProductApplicationBusinessMetrics {
        timeRange {
          start
          end
        }
        createdApplications {
          total
          authorizedUsers
          accountHolders
        }
        approvedApplications {
          total
          authorizedUsers
          accountHolders
        }
        deniedApplications
        inReviewApplications
        pendingApplications
        closedApplications
      }
    }
  }
}

Variables

{
  "input": {
    "cardProductIds": [
      "CARD_PRODUCT_ID"
    ],
    "timeRange": {
      "start": "2023-12-22T08:30:00.000Z",
      "end": "2023-12-23T08:30:00.000Z"
    }
  }
}

⚠️ Please login to execute queries. Visit the dashboard to authenticate.

Result

{
  "data": {
    "cardProductApplicationBusinessMetric": {
      "__typename": "CardProductApplicationBusinessMetricResult",
      "timeRange": {
        "start": "2023-12-22T08:30:00.000Z",
        "end": "2023-12-23T08:30:00.000Z"
      },
      "asOf": "2023-12-23T07:00:00.000Z",
      "cardProductApplicationBusinessMetrics": [
        {
          "timeRange": {
            "start": "2023-12-22T08:30:00.000Z",
            "end": "2023-12-23T08:30:00.000Z"
          },
          "createdApplications": {
            "total": 187,
            "authorizedUsers": 0,
            "accountHolders": 187
          },
          "approvedApplications": {
            "total": 134,
            "authorizedUsers": 0,
            "accountHolders": 134
          },
          "deniedApplications": 27,
          "inReviewApplications": 26,
          "pendingApplications": 0,
          "closedApplications": 0
        }
      ]
    }
  },
  "extensions": {
    "requestId": "REQUEST_ID",
    "rateLimit": {
      "cost": 6
    }
  }
}

Get transaction metrics

Transaction metrics show payment card transaction data across card products. You can use the paymentCardTransactionBusinessMetric query to retrieve the following data:

Data type	Description
timeRange	Requested start and end timestamp
asOf	Data freshness timestamp
approvedAuthorization	An authorization has been approved
declinedAuthrorization	An authorization has been declined
approvedAuthorizationAmount	The total dollar amount of approved authorizations
declinedAuthrorizationAmount	The total dollar amount of declined authorizations
Top N declinedAuthorization	Top N declined authorizations
clearedTransactions	A transaction has been successfully processed and finalized
clearedTransactionsAmount	A transaction has been successfully processed and finalized
Top N clearedTransactions	Top N cleared transactions

Use the following query to retrieve transaction metrics:

PaymentCardTransactionBusinessMetric

Query

query paymentCardTransactionBusinessMetric(
  $input: PaymentCardTransactionBusinessMetricFilterInput
) {
  paymentCardTransactionBusinessMetric(filterBy: $input) {
    __typename
    ... on PaymentCardTransactionBusinessMetricResult {
      timeRange {
        start
        end
      }
      asOf
      paymentCardTransactionBusinessMetrics {
        timeRange {
          start
          end
        }
        approvedAuthorization {
          count
          amount {
            value
            currencyCode
          }
        }
        declinedAuthorization {
          count
          amount {
            value
            currencyCode
          }
          responseCode {
            sortedDirection
            responseCodeAttributes {
              count
              amount {
                value
                currencyCode
              }
              responseCode
            }
          }
        }
        clearedTransactions {
          count
          amount {
            value
            currencyCode
          }
          topMerchantCategory {
            sortedDirection
            topMerchantCategoryAttributes {
              count
              amount {
                value
                currencyCode
              }
              merchantCategory
            }
          }
          topMerchantName {
            sortedDirection
            topMerchantNameAttributes {
              count
              amount {
                value
                currencyCode
              }
              merchantName
            }
          }
        }
      }
    }
  }
}

Variables

{
  "input": {
    "cardProductIds": [
      "CARD_PRODUCT_ID"
    ],
    "timeRange": {
      "start": "2022-12-14T08:30:00.000Z",
      "end": "2023-12-21T08:50:00.000Z"
    },
    "merchantCategoryCodes": [
      "6011",
      "5999"
    ],
    "merchantNames": []
  }
}

⚠️ Please login to execute queries. Visit the dashboard to authenticate.

Result

{
  "data": {
    "paymentCardTransactionBusinessMetric": {
      "__typename": "PaymentCardTransactionBusinessMetricResult",
      "timeRange": {
        "start": "2022-12-14T08:30:00.000Z",
        "end": "2024-01-08T08:50:00.000Z"
      },
      "asOf": "2024-01-08T07:00:00.000Z",
      "paymentCardTransactionBusinessMetrics": [
        {
          "timeRange": {
            "start": "2022-12-14T08:30:00.000Z",
            "end": "2024-01-08T08:50:00.000Z"
          },
          "approvedAuthorization": {
            "count": 44759,
            "amount": {
              "value": 82898778,
              "currencyCode": "USD"
            }
          },
          "declinedAuthorization": {
            "count": 10941,
            "amount": {
              "value": 11473384,
              "currencyCode": "USD"
            },
            "responseCode": {
              "sortedDirection": "DESCENDING",
              "responseCodeAttributes": [
                {
                  "count": 848,
                  "amount": {
                    "value": 5000,
                    "currencyCode": "USD"
                  },
                  "responseCode": "TRANSACTION_NOT_PERMITTED"
                },
                {
                  "count": 5324,
                  "amount": {
                    "value": 1234,
                    "currencyCode": "USD"
                  },
                  "responseCode": "INSUFFICIENT_FUNDS"
                },
                {
                  "count": 1329,
                  "amount": {
                    "value": 1000,
                    "currencyCode": "USD"
                  },
                  "responseCode": "DO_NOT_HONOR"
                },
                {
                  "count": 859,
                  "amount": {
                    "value": 1000,
                    "currencyCode": "USD"
                  },
                  "responseCode": "RE_ENTER_TRANSACTION"
                },
                {
                  "count": 427,
                  "amount": {
                    "value": 1000,
                    "currencyCode": "USD"
                  },
                  "responseCode": "RESTRICTED_LOCATION"
                },
                {
                  "count": 1272,
                  "amount": {
                    "value": 1000,
                    "currencyCode": "USD"
                  },
                  "responseCode": "EXCEEDS_APPROVAL_AMOUNT_LIMIT"
                },
                {
                  "count": 882,
                  "amount": {
                    "value": 1000,
                    "currencyCode": "USD"
                  },
                  "responseCode": "BAD_CVV2"
                }
              ]
            }
          },
          "clearedTransactions": {
            "count": 20857,
            "amount": {
              "value": 71425394,
              "currencyCode": "USD"
            },
            "topMerchantCategory": {
              "sortedDirection": "DESCENDING",
              "topMerchantCategoryAttributes": [
                {
                  "count": 25512,
                  "amount": {
                    "value": 60425394,
                    "currencyCode": "USD"
                  },
                  "merchantCategory": "MISCELLANEOUS_SPECIALTY_RETAIL"
                }
              ]
            },
            "topMerchantName": {
              "sortedDirection": "DESCENDING",
              "topMerchantNameAttributes": [
                {
                  "count": 160,
                  "amount": {
                    "value": 5100000,
                    "currencyCode": "USD"
                  },
                  "merchantName": "Verify Highnote Signature"
                }
              ]
            }
          }
        }
      ]
    }
  },
  "extensions": {
    "requestId": "REQUEST_ID",
    "rateLimit": {
      "cost": 19
    }
  }
}