Retrieve Report

Retrieve a performance report

get/v2/auth_rules/{auth_rule_token}/report

Retrieves a performance report for an Auth rule containing daily statistics and evaluation outcomes.

Time Range Limitations:

• Reports are supported for the past 3 months only
• Maximum interval length is 1 month
• Report data is available only through the previous day in UTC (current day data is not available)

The report provides daily statistics for both current and draft versions of the Auth rule, including approval, decline, and challenge counts along with sample events.

Path Parameters

auth_rule_tokenstring

formatuuid

Query Parameters

beginstring

Start date for the report

formatdate

endstring

End date for the report

formatdate

Returns

auth_rule_tokenstring

Auth Rule Token

formatuuid

beginstring

The start date (UTC) of the report.

formatdate

daily_statisticsarray of object

Daily evaluation statistics for the Auth Rule.

Hide ParametersShow Parameters

current_version_statisticsapprovednumberchallengednumberdeclinednumberexamplesarray of objectversionnumberRuleStats

Detailed statistics for the current version of the rule.

datestring

The date (UTC) for which the statistics are reported.

formatdate

draft_version_statisticsapprovednumberchallengednumberdeclinednumberexamplesarray of objectversionnumberRuleStats

Detailed statistics for the draft version of the rule.

endstring

The end date (UTC) of the report.

formatdate

Request example Request

curl https://api.lithic.com/v2/auth_rules/$AUTH_RULE_TOKEN/report \
    -H "Authorization: $LITHIC_API_KEY" \
    -d '{}'

200 Example

{
  "auth_rule_token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "begin": "2019-12-27",
  "daily_statistics": [
    {
      "current_version_statistics": {
        "approved": 0,
        "challenged": 0,
        "declined": 0,
        "examples": [
          {
            "approved": true,
            "decision": "APPROVED",
            "event_token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            "timestamp": "2019-12-27T18:11:19.117Z"
          }
        ]
      },
      "date": "2019-12-27",
      "draft_version_statistics": {
        "approved": 0,
        "challenged": 0,
        "declined": 0,
        "examples": [
          {
            "approved": true,
            "decision": "APPROVED",
            "event_token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            "timestamp": "2019-12-27T18:11:19.117Z"
          }
        ]
      }
    }
  ],
  "end": "2019-12-27"
}