Create Custom Report

Definition

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


This request allows you to select a report category and specify which of its columns to include in order to create your own custom report.

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


Request Content

Send a customReport object, with the following:

Property

Type

Required

title

string

required

info

string

optional

category

string

required

columns

array

required

Response Details

If successful, the response HTTP status code is 200 OK. The response contains the request properties plus an id property, which is needed when you manage or run the report in the future.


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