{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","settings":"","results":{"codes":[]},"params":[],"examples":{"codes":[]},"method":"get"},"next":{"description":"","pages":[]},"title":"Run Custom Report","type":"endpoint","slug":"run-custom-report","excerpt":"","body":"## Definition\nhttps<span>://sandbox.bluesnap.com/services/2/report/dynamic/{report ID}?{query params}</span>\n\n<hr>\n\n## Documentation\nThis request allows you to run your custom report and get the data in either JSON or CSV format. \n\n### Request Content\nEnter the report's ID and any relevant [query parameters](doc:query-parameters) in the request URL, as follows: \n\n`services/2/report/dynamic/{report ID}?{parameters}`\n\nFor example: `services/2/report/dynamic/12141?period=THIS_MONTH&currency=USD`\n\nNo content is required in the request body.\n\n#### Query parameters\nQuery parameters are used to filter report results. Refer to [Query Parameters](doc:query-parameters) for full details. \n\n#### Pagination\nPagination is supported. Refer to [Report Pagination](doc:report-pagination) for full details.\n\n### Response Details \nIf successful, the HTTP status code is 200 OK. The report data is included in the response.   \n\n<hr>\n \n## Examples \n### Request Examples  \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -v -X GET https://sandbox.bluesnap.com/services/2/report/dynamic/7637?period=LAST_WEEK \\\\\\n-H 'Content-Type: application/json' \\\\ \\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\",\n      \"language\": \"curl\",\n      \"name\": \"Run Custom Report\"\n    }\n  ]\n}\n[/block]\n### Response Examples \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"data\\\": [\\n    {\\n      \\\"Merchant Sales (Auth Currency)\\\": \\\"10.63\\\",\\n      \\\"Auth. Currency\\\": \\\"USD\\\",\\n      \\\"Merchant Transaction ID\\\": \\\"21eeaadc-61e8-4497-8535-534f042a3494\\\",\\n      \\\"Transaction Date\\\": \\\"12/18/2020\\\",\\n      \\\"Transaction Type\\\": \\\"Sale\\\"\\n    },\\n    {\\n      \\\"Merchant Sales (Auth Currency)\\\": \\\"11.00\\\",\\n      \\\"Auth. Currency\\\": \\\"USD\\\",\\n      \\\"Merchant Transaction ID\\\": \\\"\\\",\\n      \\\"Transaction Date\\\": \\\"12/18/2020\\\",\\n      \\\"Transaction Type\\\": \\\"Sale\\\"\\n    },\\n    {\\n      \\\"Merchant Sales (Auth Currency)\\\": \\\"11.00\\\",\\n      \\\"Auth. Currency\\\": \\\"USD\\\",\\n      \\\"Merchant Transaction ID\\\": \\\"\\\",\\n      \\\"Transaction Date\\\": \\\"12/18/2020\\\",\\n      \\\"Transaction Type\\\": \\\"Sale\\\"\\n    },\\n    {\\n      \\\"Merchant Sales (Auth Currency)\\\": \\\"11.00\\\",\\n      \\\"Auth. Currency\\\": \\\"USD\\\",\\n      \\\"Merchant Transaction ID\\\": \\\"\\\",\\n      \\\"Transaction Date\\\": \\\"12/18/2020\\\",\\n      \\\"Transaction Type\\\": \\\"Sale\\\"\\n    },\\n    {\\n      \\\"Merchant Sales (Auth Currency)\\\": \\\"11.00\\\",\\n      \\\"Auth. Currency\\\": \\\"USD\\\",\\n      \\\"Merchant Transaction ID\\\": \\\"\\\",\\n      \\\"Transaction Date\\\": \\\"12/18/2020\\\",\\n      \\\"Transaction Type\\\": \\\"Sale\\\"\\n    },\\n    {\\n      \\\"Merchant Sales (Auth Currency)\\\": \\\"2.00\\\",\\n      \\\"Auth. Currency\\\": \\\"USD\\\",\\n      \\\"Merchant Transaction ID\\\": \\\"\\\",\\n      \\\"Transaction Date\\\": \\\"12/18/2020\\\",\\n      \\\"Transaction Type\\\": \\\"Sale\\\"\\n    },\\n    {\\n      \\\"Merchant Sales (Auth Currency)\\\": \\\"2.00\\\",\\n      \\\"Auth. Currency\\\": \\\"USD\\\",\\n      \\\"Merchant Transaction ID\\\": \\\"\\\",\\n      \\\"Transaction Date\\\": \\\"12/18/2020\\\",\\n      \\\"Transaction Type\\\": \\\"Sale\\\"\\n    },\\n    {\\n      \\\"Merchant Sales (Auth Currency)\\\": \\\"2.00\\\",\\n      \\\"Auth. Currency\\\": \\\"USD\\\",\\n      \\\"Merchant Transaction ID\\\": \\\"\\\",\\n      \\\"Transaction Date\\\": \\\"12/18/2020\\\",\\n      \\\"Transaction Type\\\": \\\"Sale\\\"\\n    },\\n    {\\n      \\\"Merchant Sales (Auth Currency)\\\": \\\"2.00\\\",\\n      \\\"Auth. Currency\\\": \\\"USD\\\",\\n      \\\"Merchant Transaction ID\\\": \\\"\\\",\\n      \\\"Transaction Date\\\": \\\"12/18/2020\\\",\\n      \\\"Transaction Type\\\": \\\"Sale\\\"\\n    },\\n    {\\n      \\\"Merchant Sales (Auth Currency)\\\": \\\"2.00\\\",\\n      \\\"Auth. Currency\\\": \\\"USD\\\",\\n      \\\"Merchant Transaction ID\\\": \\\"\\\",\\n      \\\"Transaction Date\\\": \\\"12/18/2020\\\",\\n      \\\"Transaction Type\\\": \\\"Sale\\\"\\n    },\\n    {\\n      \\\"Merchant Sales (Auth Currency)\\\": \\\"11.00\\\",\\n      \\\"Auth. Currency\\\": \\\"USD\\\",\\n      \\\"Merchant Transaction ID\\\": \\\"\\\",\\n      \\\"Transaction Date\\\": \\\"12/17/2020\\\",\\n      \\\"Transaction Type\\\": \\\"Sale\\\"\\n    },\\n    {\\n      \\\"Merchant Sales (Auth Currency)\\\": \\\"10.00\\\",\\n      \\\"Auth. Currency\\\": \\\"USD\\\",\\n      \\\"Merchant Transaction ID\\\": \\\"\\\",\\n      \\\"Transaction Date\\\": \\\"12/17/2020\\\",\\n      \\\"Transaction Type\\\": \\\"Sale\\\"\\n    },\\n    {\\n      \\\"Merchant Sales (Auth Currency)\\\": \\\"10.00\\\",\\n      \\\"Auth. Currency\\\": \\\"USD\\\",\\n      \\\"Merchant Transaction ID\\\": \\\"\\\",\\n      \\\"Transaction Date\\\": \\\"12/17/2020\\\",\\n      \\\"Transaction Type\\\": \\\"Sale\\\"\\n    },\\n    {\\n      \\\"Merchant Sales (Auth Currency)\\\": \\\"10.00\\\",\\n      \\\"Auth. Currency\\\": \\\"USD\\\",\\n      \\\"Merchant Transaction ID\\\": \\\"\\\",\\n      \\\"Transaction Date\\\": \\\"12/16/2020\\\",\\n      \\\"Transaction Type\\\": \\\"Sale\\\"\\n    },\\n    {\\n      \\\"Merchant Sales (Auth Currency)\\\": \\\"10.00\\\",\\n      \\\"Auth. Currency\\\": \\\"USD\\\",\\n      \\\"Merchant Transaction ID\\\": \\\"\\\",\\n      \\\"Transaction Date\\\": \\\"12/16/2020\\\",\\n      \\\"Transaction Type\\\": \\\"Sale\\\"\\n    },\\n    {\\n      \\\"Merchant Sales (Auth Currency)\\\": \\\"10.00\\\",\\n      \\\"Auth. Currency\\\": \\\"USD\\\",\\n      \\\"Merchant Transaction ID\\\": \\\"\\\",\\n      \\\"Transaction Date\\\": \\\"12/16/2020\\\",\\n      \\\"Transaction Type\\\": \\\"Sale\\\"\\n    },\\n    {\\n      \\\"Merchant Sales (Auth Currency)\\\": \\\"10.00\\\",\\n      \\\"Auth. Currency\\\": \\\"USD\\\",\\n      \\\"Merchant Transaction ID\\\": \\\"\\\",\\n      \\\"Transaction Date\\\": \\\"12/16/2020\\\",\\n      \\\"Transaction Type\\\": \\\"Sale\\\"\\n    },\\n    {\\n      \\\"Merchant Sales (Auth Currency)\\\": \\\"31.88\\\",\\n      \\\"Auth. Currency\\\": \\\"USD\\\",\\n      \\\"Merchant Transaction ID\\\": \\\"20a4ed29-7e50-4239-890f-24865a677095\\\",\\n      \\\"Transaction Date\\\": \\\"12/16/2020\\\",\\n      \\\"Transaction Type\\\": \\\"Sale\\\"\\n    },\\n    {\\n      \\\"Merchant Sales (Auth Currency)\\\": \\\"11.69\\\",\\n      \\\"Auth. Currency\\\": \\\"USD\\\",\\n      \\\"Merchant Transaction ID\\\": \\\"0d4e2ab0-ed98-42a6-8c83-a063891a2550\\\",\\n      \\\"Transaction Date\\\": \\\"12/16/2020\\\",\\n      \\\"Transaction Type\\\": \\\"Sale\\\"\\n    },\\n    {\\n      \\\"Merchant Sales (Auth Currency)\\\": \\\"10.63\\\",\\n      \\\"Auth. Currency\\\": \\\"USD\\\",\\n      \\\"Merchant Transaction ID\\\": \\\"c69af47e-e001-42e9-a91d-1956283daca1\\\",\\n      \\\"Transaction Date\\\": \\\"12/16/2020\\\",\\n      \\\"Transaction Type\\\": \\\"Sale\\\"\\n    },\\n    {\\n      \\\"Merchant Sales (Auth Currency)\\\": \\\"10.00\\\",\\n      \\\"Auth. Currency\\\": \\\"USD\\\",\\n      \\\"Merchant Transaction ID\\\": \\\"\\\",\\n      \\\"Transaction Date\\\": \\\"12/16/2020\\\",\\n      \\\"Transaction Type\\\": \\\"Sale\\\"\\n    },\\n    {\\n      \\\"Merchant Sales (Auth Currency)\\\": \\\"10.00\\\",\\n      \\\"Auth. Currency\\\": \\\"USD\\\",\\n      \\\"Merchant Transaction ID\\\": \\\"\\\",\\n      \\\"Transaction Date\\\": \\\"12/16/2020\\\",\\n      \\\"Transaction Type\\\": \\\"Sale\\\"\\n    },\\n    {\\n      \\\"Merchant Sales (Auth Currency)\\\": \\\"10.63\\\",\\n      \\\"Auth. Currency\\\": \\\"USD\\\",\\n      \\\"Merchant Transaction ID\\\": \\\"74f0a040-58ee-43ad-a48b-5964c463f024\\\",\\n      \\\"Transaction Date\\\": \\\"12/16/2020\\\",\\n      \\\"Transaction Type\\\": \\\"Sale\\\"\\n    },\\n    {\\n      \\\"Merchant Sales (Auth Currency)\\\": \\\"10.00\\\",\\n      \\\"Auth. Currency\\\": \\\"USD\\\",\\n      \\\"Merchant Transaction ID\\\": \\\"\\\",\\n      \\\"Transaction Date\\\": \\\"12/16/2020\\\",\\n      \\\"Transaction Type\\\": \\\"Sale\\\"\\n    },\\n    {\\n      \\\"Merchant Sales (Auth Currency)\\\": \\\"10.00\\\",\\n      \\\"Auth. Currency\\\": \\\"USD\\\",\\n      \\\"Merchant Transaction ID\\\": \\\"\\\",\\n      \\\"Transaction Date\\\": \\\"12/16/2020\\\",\\n      \\\"Transaction Type\\\": \\\"Sale\\\"\\n    },\\n    {\\n      \\\"Merchant Sales (Auth Currency)\\\": \\\"0.00\\\",\\n      \\\"Auth. Currency\\\": \\\"USD\\\",\\n      \\\"Merchant Transaction ID\\\": \\\"\\\",\\n      \\\"Transaction Date\\\": \\\"12/15/2020\\\",\\n      \\\"Transaction Type\\\": \\\"Sale\\\"\\n    },\\n    {\\n      \\\"Merchant Sales (Auth Currency)\\\": \\\"29.99\\\",\\n      \\\"Auth. Currency\\\": \\\"USD\\\",\\n      \\\"Merchant Transaction ID\\\": \\\"\\\",\\n      \\\"Transaction Date\\\": \\\"12/15/2020\\\",\\n      \\\"Transaction Type\\\": \\\"Sale\\\"\\n    },\\n    {\\n      \\\"Merchant Sales (Auth Currency)\\\": \\\"100.00\\\",\\n      \\\"Auth. Currency\\\": \\\"USD\\\",\\n      \\\"Merchant Transaction ID\\\": \\\"\\\",\\n      \\\"Transaction Date\\\": \\\"12/14/2020\\\",\\n      \\\"Transaction Type\\\": \\\"Sale\\\"\\n    },\\n    {\\n      \\\"Merchant Sales (Auth Currency)\\\": \\\"25.00\\\",\\n      \\\"Auth. Currency\\\": \\\"USD\\\",\\n      \\\"Merchant Transaction ID\\\": \\\"\\\",\\n      \\\"Transaction Date\\\": \\\"12/13/2020\\\",\\n      \\\"Transaction Type\\\": \\\"Sale\\\"\\n    }\\n  ],\\n  \\\"title\\\": \\\"Transaction Report 1\\\",\\n  \\\"params\\\": [\\n    {\\n      \\\"name\\\": \\\"Period\\\",\\n      \\\"value\\\": \\\"LAST_WEEK\\\"\\n    },\\n    {\\n      \\\"name\\\": \\\"Merchant Id\\\",\\n      \\\"value\\\": \\\"500605\\\"\\n    }\\n  ],\\n  \\\"date_range\\\": \\\"12/13/2020 - 12/19/2020\\\"\\n}\\n\",\n      \"language\": \"json\",\n      \"name\": \"200 OK\"\n    }\n  ]\n}\n[/block]","updates":[],"order":6,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"60957f4cce403c0045a0324e","createdAt":"2020-11-03T17:12:02.027Z","user":"5ea72d649148ff00653f6bbc","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Custom Reporting API","slug":"dynamic-reporting-api","order":2,"from_sync":false,"reference":false,"_id":"60957f4cce403c0045a031f5","createdAt":"2020-11-03T16:46:14.694Z","version":"60957f4cce403c0045a03255","project":"57336fd5a6a9c40e00e13a0b","__v":0},"version":{"version":"8976-Tools","version_clean":"8976.0.0-Tools","codename":"3.38 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["60957f4cce403c0045a031e3","60957f4cce403c0045a031e4","60957f4cce403c0045a031e5","60957f4cce403c0045a031e6","60957f4cce403c0045a031e7","60957f4cce403c0045a031e8","60957f4cce403c0045a031e9","60957f4cce403c0045a031ea","60957f4cce403c0045a031eb","60957f4cce403c0045a031ec","60957f4cce403c0045a031ed","60957f4cce403c0045a031ee","5b34c737e0dca2000311de6a","60957f4cce403c0045a031ef","60957f4cce403c0045a031f0","60957f4cce403c0045a031f1","60957f4cce403c0045a031f2","60957f4cce403c0045a031f3","60957f4cce403c0045a031f4","60957f4cce403c0045a031f5"],"_id":"60957f4cce403c0045a03255","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"603fec227146110018e1daaf","createdAt":"2018-04-23T15:17:35.680Z","releaseDate":"2018-04-23T15:17:35.680Z"},"project":"57336fd5a6a9c40e00e13a0b","__v":0,"parentDoc":null}

getRun Custom Report


Definition

https://sandbox.bluesnap.com/services/2/report/dynamic/{report ID}?{query params}


Documentation

This request allows you to run your custom report and get the data in either JSON or CSV format.

Request Content

Enter the report's ID and any relevant query parameters in the request URL, as follows:

services/2/report/dynamic/{report ID}?{parameters}

For example: services/2/report/dynamic/12141?period=THIS_MONTH&currency=USD

No content is required in the request body.

Query parameters

Query parameters are used to filter report results. Refer to Query Parameters for full details.

Pagination

Pagination is supported. Refer to Report Pagination for full details.

Response Details

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


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