Reports

List reports

Lists generated reports.

get/api/v2/reports

Query parameters

limitstring number

Number of reports to return

createdAtGtstring date-time

Only return reports created after this date

createdAtLtestring date-time

Only return reports created before or on this date

enterprisestring

Only return reports for this enterprise

walletstring

Only return reports for this wallet

walletTypestring

Only return reports for this wallet type

reportType'holdings' | 'transactions' | 'trades' | 'staking' | 'holdingsByAddress' | 'userAccess' | 'policies' | 'costBasis' | 'gasTankReport' | 'organizationHoldings' | 'organizationHoldingsByAddress' | 'organizationTransactions' | 'organizationTrades' | 'organizationStaking' | 'organizationHoldingsV2' | 'organizationTransactionsV2' | 'quarterly'

Only return reports for this report type

status'pending' | 'processing' | 'completed' | 'failed'

Only return rports for this report status

prevIdstring

Only return reports created after this ID

format'csv' | 'pdf'

Only return reports for this report format

assetstring

Only return reports for this report asset

{"stackTrail":"paths:/api/v2/reports:get:parameters:11:schema","oasType":"schema","type":"unknown"}

Only return reports for this report asset

sortOrder'asc' | 'desc'

Sort order of returned reports based on _id.

Response

OK

nextBatchPrevIdstring

Example response

{
  "reports": [
    {
      "holdings": {
        "enterprise": "59cd72485007a239fb00282ed480da1f"
      },
      "transactions": {
        "enterprise": "59cd72485007a239fb00282ed480da1f",
        "wallets": [
          "59cd72485007a239fb00282ed480da1f"
        ]
      },
      "quarterly": {
        "enterprise": "59cd72485007a239fb00282ed480da1f"
      },
      "trades": {
        "enterprise": "59cd72485007a239fb00282ed480da1f"
      },
      "staking": {
        "enterprise": "59cd72485007a239fb00282ed480da1f",
        "wallets": [
          "59cd72485007a239fb00282ed480da1f"
        ]
      },
      "gasTankReport": {
        "enterprise": "59cd72485007a239fb00282ed480da1f"
      },
      "holdingsByAddress": {
        "wallets": [
          "59cd72485007a239fb00282ed480da1f"
        ]
      },
      "organizationTransactions": {
        "wallets": [
          "59cd72485007a239fb00282ed480da1f"
        ]
      },
      "organizationTransactionsV2": {
        "wallets": [
          "59cd72485007a239fb00282ed480da1f"
        ]
      },
      "organizationHoldingsByAddress": {
        "wallets": [
          "59cd72485007a239fb00282ed480da1f"
        ]
      },
      "organizationStaking": {
        "wallets": [
          "59cd72485007a239fb00282ed480da1f"
        ]
      },
      "costBasis": {
        "enterprise": "59cd72485007a239fb00282ed480da1f"
      },
      "id": "59cd72485007a239fb00282ed480da1f",
      "user": "59cd72485007a239fb00282ed480da1f"
    }
  ]
}

Changes

Changed in 1 of the 33 revisions of this API.12

  • b8a54d28235412See the full diff
    • ●

      added the new gasTankReport enum value to the //// response property for the response status

      response-property-enum-value-added

    • ○

      added the new enum value gasTankReport to the query request parameter reportType

      request-parameter-enum-value-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added