Reports

List org-level reports

Changed on

Lists generated reports.

get/api/v2/organization/{organizationId}/reports

Request

  • Base URL
    https://developers.bitgo.com
  • URL
    https://developers.bitgo.com/api/v2/organization/{organizationId}/reports
  • Auth
    none declared

Path parameters

organizationIdstring required
Example:59cd72485007a239fb00282ed480da1f

Query parameters

limitstring number

Number of reports to return

createdAtGtstring date-time

Only return reports created after this date

enterprisestring

Only return reports that includes 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' | 'cmeSecurityBalance' | '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

reportParamsunknown

Only return reports for this report asset

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

  • 41968a022e9fRevision changes
    • info

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

  • ce1c5b8fa103Revision changes
    • warning

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

    • info

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

    • info

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