Skip to main content

Performance statistics of a wallet provider

GET 

/v2/config/digital-wallet/openid/wallet-provider/statistics

Reads the performance statistics of a wallet provider. The statistics give the OID4VCI issuance totals, the OpenID4VP verification totals, the monthly issuance history, and the counts of individual and organisation wallet units. The service caches the statistics and refreshes them in the background. The organisation must have the wallet provider capability enabled.

The service can return statistics from its cache while it refreshes them in the background, so the values can be a few minutes old.

Request

Header Parameters

    X-SandboxOrgId stringrequired

    Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.

    The service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org instead.

    X-SubwalletId is the deprecated name of this header. The service continues to accept it, but X-SandboxOrgId wins if you send both headers.

    The sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.

    Example: 6889e1a4c5b2f30001a3d710

Responses

The service returned the performance statistics.

Response Headers
    Schema
      performanceStatistics objectrequired

      The performance statistics of the wallet provider.

      oid4vc object

      Issuance and verification totals.

      totalCredentialTypes integerrequired

      Number of credential types.

      totalIssuedCredentials integerrequired

      Number of issued credentials.

      totalVerifications integerrequired

      Number of verifications.

      totalCredentialIssuanceHistory object

      Monthly credential issuance and verification history. Each field holds an array with one record per month, newest first.

      currentMonth object[]required

      Data for the current month. The array holds one record.

    • Array [
    • month stringrequired

      Month of the data, in the format <month-name>-<year>.

      totalCredentialTypes integerrequired

      Number of credential types in the month.

      totalIssuedCredentials integerrequired

      Number of credentials issued in the month.

      totalVerifications integerrequired

      Number of verifications in the month.

    • ]
    • last3Months object[]required

      Data for each of the last 3 months.

    • Array [
    • month stringrequired

      Month of the data, in the format <month-name>-<year>.

      totalCredentialTypes integerrequired

      Number of credential types in the month.

      totalIssuedCredentials integerrequired

      Number of credentials issued in the month.

      totalVerifications integerrequired

      Number of verifications in the month.

    • ]
    • last6Months object[]required

      Data for each of the last 6 months.

    • Array [
    • month stringrequired

      Month of the data, in the format <month-name>-<year>.

      totalCredentialTypes integerrequired

      Number of credential types in the month.

      totalIssuedCredentials integerrequired

      Number of credentials issued in the month.

      totalVerifications integerrequired

      Number of verifications in the month.

    • ]
    • last12Months object[]required

      Data for each of the last 12 months.

    • Array [
    • month stringrequired

      Month of the data, in the format <month-name>-<year>.

      totalCredentialTypes integerrequired

      Number of credential types in the month.

      totalIssuedCredentials integerrequired

      Number of credentials issued in the month.

      totalVerifications integerrequired

      Number of verifications in the month.

    • ]
    • cumulative objectrequired

      Totals over all months. The service does not calculate this object today, so every count is 0.

      totalCredentialTypes integerrequired

      Number of credential types.

      totalIssuedCredentials integerrequired

      Number of issued credentials.

      totalVerifications integerrequired

      Number of verifications.

      individualWalletUnit object

      Counts of wallet units of one kind.

      total integerrequired

      Number of wallet units.

      active integerrequired

      Number of wallet units with a valid Wallet Unit Attestation.

      revoked integerrequired

      Number of revoked wallet units. The service makes this value from total minus active.

      organisationWalletUnit object

      Counts of wallet units of one kind.

      total integerrequired

      Number of wallet units.

      active integerrequired

      Number of wallet units with a valid Wallet Unit Attestation.

      revoked integerrequired

      Number of revoked wallet units. The service makes this value from total minus active.

    Loading...