Definition

https://sandbox.bluesnap.com/services/2/report/dynamic-def


This request allows you to create a custom report. You can select a report category and specify which of its columns to include.

Note: You can have up to 50 custom reports saved at one time.


Request Content

Send a customReport object including the following:

PropertyTypeRequired
titlestringrequired
infostringoptional
categorystringrequired
columnsarrayrequired

Response Content

If successful, the response HTTP status code is 200 OK. The response contains the request properties and the id property, which is required whenever you manage or run the report.


Examples

Request Examples

curl -v -X POST https://sandbox.bluesnap.com/services/2/report/dynamic-def \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \ 
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
  "category": "TransactionCategory",
  "title": "My custom transaction report",
  "columns": [
    {"name": "Merchant Sales (Auth Currency)"},
    {"name": "Auth. Currency"},
    {"name": "Merchant Transaction ID"},
    {"name": "Transaction Date"},
    {"name": "Transaction Type"}
  ]
}'
curl -v -X POST https://sandbox.bluesnap.com/services/2/report/dynamic-def \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \ 
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
  "category": "PayoutCategory",
  "title": "My custom payout report",
  "columns": [
    {"name": "Merchant Transaction ID"},
    {"name": "Transaction Amount"},
    {"name": "Transaction Currency"},
    {"name": "Gross Payout Amount"},
    {"name": "Payment ID"}
  ]
}'

Reponse Examples

{
  "id": 7637,
  "category": "TransactionCategory",
  "title": "My custom transaction report",
  "columns": [
    {
      "name": "Merchant Sales (Auth Currency)"
    },
    {
      "name": "Auth. Currency"
    },
    {
      "name": "Merchant Transaction ID"
    },
    {
      "name": "Transaction Date"
    },
    {
      "name": "Transaction Type"
    }
  ]
}
{
  "id": 7641,
  "category": "PayoutCategory",
  "title": "My custom payout report",
  "columns": [
    {
      "name": "Merchant Transaction ID"
    },
    {
      "name": "Transaction Amount"
    },
    {
      "name": "Transaction Currency"
    },
    {
      "name": "Gross Payout Amount"
    },
    {
      "name": "Payment ID"
    }
  ]
}