Run Custom Report

This request runs a custom report by id and returns the data in either JSON or CSV format.

Endpoint

https://sandbox.bluesnap.com/services/2/report/dynamic/{reportId}?param=value[&param=value...]

Request Content

Enter the report ID and any relevant query string parameters in the request URL:

services/2/report/dynamic/{reportId}?param=value[&param=value...]

For example:

services/2/report/dynamic/12141?period=THIS_MONTH¤cy=USD

No content is required in the request body.

Query String Parameters

Filter report results with query string parameters.

Pagination

Report Pagination describes how the Reporting API supports pagination.

Response Details

If successful, the HTTP status code is 200 OK. Report data is included in the response.

Errors

This endpoint returns the following errors in response to reporting API requests:

Code	Name	Description
21001	INVALID_INPUT	In case of bad input errors, the API returns HTTP code 400, along with information about the error. For example: `Invalid Next Page Token`
21002	GENERAL_REPORT_ERROR	In case of service errors, the API returns HTTP code 500, along with this message: `BI Reports are currently unavailable; please try again later.`

Examples

Request Examples

curl -v -X GET https://sandbox.bluesnap.com/services/2/report/dynamic/7637?period=LAST_WEEK \
-H 'Content-Type: application/json' \ 
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '

Response Examples

{
  "data": [
    {
      "Merchant Sales (Auth Currency)": "10.63",
      "Auth. Currency": "USD",
      "Merchant Transaction ID": "21eeaadc-61e8-4497-8535-534f042a3494",
      "Transaction Date": "12/18/2020",
      "Transaction Type": "Sale"
    },
    {
      "Merchant Sales (Auth Currency)": "11.00",
      "Auth. Currency": "USD",
      "Merchant Transaction ID": "",
      "Transaction Date": "12/18/2020",
      "Transaction Type": "Sale"
    },
    {
      "Merchant Sales (Auth Currency)": "11.00",
      "Auth. Currency": "USD",
      "Merchant Transaction ID": "",
      "Transaction Date": "12/18/2020",
      "Transaction Type": "Sale"
    },
    {
      "Merchant Sales (Auth Currency)": "11.00",
      "Auth. Currency": "USD",
      "Merchant Transaction ID": "",
      "Transaction Date": "12/18/2020",
      "Transaction Type": "Sale"
    },
    {
      "Merchant Sales (Auth Currency)": "11.00",
      "Auth. Currency": "USD",
      "Merchant Transaction ID": "",
      "Transaction Date": "12/18/2020",
      "Transaction Type": "Sale"
    },
    {
      "Merchant Sales (Auth Currency)": "2.00",
      "Auth. Currency": "USD",
      "Merchant Transaction ID": "",
      "Transaction Date": "12/18/2020",
      "Transaction Type": "Sale"
    },
    {
      "Merchant Sales (Auth Currency)": "2.00",
      "Auth. Currency": "USD",
      "Merchant Transaction ID": "",
      "Transaction Date": "12/18/2020",
      "Transaction Type": "Sale"
    },
    {
      "Merchant Sales (Auth Currency)": "2.00",
      "Auth. Currency": "USD",
      "Merchant Transaction ID": "",
      "Transaction Date": "12/18/2020",
      "Transaction Type": "Sale"
    },
    {
      "Merchant Sales (Auth Currency)": "2.00",
      "Auth. Currency": "USD",
      "Merchant Transaction ID": "",
      "Transaction Date": "12/18/2020",
      "Transaction Type": "Sale"
    },
    {
      "Merchant Sales (Auth Currency)": "2.00",
      "Auth. Currency": "USD",
      "Merchant Transaction ID": "",
      "Transaction Date": "12/18/2020",
      "Transaction Type": "Sale"
    },
    {
      "Merchant Sales (Auth Currency)": "11.00",
      "Auth. Currency": "USD",
      "Merchant Transaction ID": "",
      "Transaction Date": "12/17/2020",
      "Transaction Type": "Sale"
    },
    {
      "Merchant Sales (Auth Currency)": "10.00",
      "Auth. Currency": "USD",
      "Merchant Transaction ID": "",
      "Transaction Date": "12/17/2020",
      "Transaction Type": "Sale"
    },
    {
      "Merchant Sales (Auth Currency)": "10.00",
      "Auth. Currency": "USD",
      "Merchant Transaction ID": "",
      "Transaction Date": "12/17/2020",
      "Transaction Type": "Sale"
    },
    {
      "Merchant Sales (Auth Currency)": "10.00",
      "Auth. Currency": "USD",
      "Merchant Transaction ID": "",
      "Transaction Date": "12/16/2020",
      "Transaction Type": "Sale"
    },
    {
      "Merchant Sales (Auth Currency)": "10.00",
      "Auth. Currency": "USD",
      "Merchant Transaction ID": "",
      "Transaction Date": "12/16/2020",
      "Transaction Type": "Sale"
    },
    {
      "Merchant Sales (Auth Currency)": "10.00",
      "Auth. Currency": "USD",
      "Merchant Transaction ID": "",
      "Transaction Date": "12/16/2020",
      "Transaction Type": "Sale"
    },
    {
      "Merchant Sales (Auth Currency)": "10.00",
      "Auth. Currency": "USD",
      "Merchant Transaction ID": "",
      "Transaction Date": "12/16/2020",
      "Transaction Type": "Sale"
    },
    {
      "Merchant Sales (Auth Currency)": "31.88",
      "Auth. Currency": "USD",
      "Merchant Transaction ID": "20a4ed29-7e50-4239-890f-24865a677095",
      "Transaction Date": "12/16/2020",
      "Transaction Type": "Sale"
    },
    {
      "Merchant Sales (Auth Currency)": "11.69",
      "Auth. Currency": "USD",
      "Merchant Transaction ID": "0d4e2ab0-ed98-42a6-8c83-a063891a2550",
      "Transaction Date": "12/16/2020",
      "Transaction Type": "Sale"
    },
    {
      "Merchant Sales (Auth Currency)": "10.63",
      "Auth. Currency": "USD",
      "Merchant Transaction ID": "c69af47e-e001-42e9-a91d-1956283daca1",
      "Transaction Date": "12/16/2020",
      "Transaction Type": "Sale"
    },
    {
      "Merchant Sales (Auth Currency)": "10.00",
      "Auth. Currency": "USD",
      "Merchant Transaction ID": "",
      "Transaction Date": "12/16/2020",
      "Transaction Type": "Sale"
    },
    {
      "Merchant Sales (Auth Currency)": "10.00",
      "Auth. Currency": "USD",
      "Merchant Transaction ID": "",
      "Transaction Date": "12/16/2020",
      "Transaction Type": "Sale"
    },
    {
      "Merchant Sales (Auth Currency)": "10.63",
      "Auth. Currency": "USD",
      "Merchant Transaction ID": "74f0a040-58ee-43ad-a48b-5964c463f024",
      "Transaction Date": "12/16/2020",
      "Transaction Type": "Sale"
    },
    {
      "Merchant Sales (Auth Currency)": "10.00",
      "Auth. Currency": "USD",
      "Merchant Transaction ID": "",
      "Transaction Date": "12/16/2020",
      "Transaction Type": "Sale"
    },
    {
      "Merchant Sales (Auth Currency)": "10.00",
      "Auth. Currency": "USD",
      "Merchant Transaction ID": "",
      "Transaction Date": "12/16/2020",
      "Transaction Type": "Sale"
    },
    {
      "Merchant Sales (Auth Currency)": "0.00",
      "Auth. Currency": "USD",
      "Merchant Transaction ID": "",
      "Transaction Date": "12/15/2020",
      "Transaction Type": "Sale"
    },
    {
      "Merchant Sales (Auth Currency)": "29.99",
      "Auth. Currency": "USD",
      "Merchant Transaction ID": "",
      "Transaction Date": "12/15/2020",
      "Transaction Type": "Sale"
    },
    {
      "Merchant Sales (Auth Currency)": "100.00",
      "Auth. Currency": "USD",
      "Merchant Transaction ID": "",
      "Transaction Date": "12/14/2020",
      "Transaction Type": "Sale"
    },
    {
      "Merchant Sales (Auth Currency)": "25.00",
      "Auth. Currency": "USD",
      "Merchant Transaction ID": "",
      "Transaction Date": "12/13/2020",
      "Transaction Type": "Sale"
    }
  ],
  "title": "Transaction Report 1",
  "params": [
    {
      "name": "Period",
      "value": "LAST_WEEK"
    },
    {
      "name": "Merchant Id",
      "value": "500605"
    }
  ],
  "date_range": "12/13/2020 - 12/19/2020"
}