Reports

Generate org-level report

Changed on

Creates a new report in pending status.

post/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

Request body

type'organizationHoldings' | 'organizationHoldingsByAddress' | 'organizationTransactions' | 'organizationTrades' | 'organizationStaking' | 'organizationHoldingsV2' | 'organizationTransactionsV2' | 'userAccess' required
format'csv' | 'pdf' required

Example request

{
  "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"
  }
}

Response

OK

idstring required
type'holdings' | 'transactions' | 'trades' | 'staking' | 'holdingsByAddress' | 'userAccess' | 'policies' | 'costBasis' | 'gasTankReport' | 'cmeSecurityBalance' | 'organizationHoldings' | 'organizationHoldingsByAddress' | 'organizationTransactions' | 'organizationTrades' | 'organizationStaking' | 'organizationHoldingsV2' | 'organizationTransactionsV2' | 'quarterly' required
format'csv' | 'pdf' required
status'pending' | 'processing' | 'completed' | 'failed' required
createdAtstring date-time required

Date report was created

completedAtstring date-time

Date report was completed

documentNamestring

Name of the report document

userstring required

ID of the user who requested the report

Example response

{
  "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 new optional request property /

    • 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 optional request property

    • info

      added the optional property / to the response with the status