{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","settings":"","results":{"codes":[]},"params":[],"examples":{"codes":[]},"method":"get"},"next":{"description":"","pages":[]},"title":"Retrieve Custom Report","type":"endpoint","slug":"retrieve-custom-report","excerpt":"","body":"## Definition\nhttps<span>://sandbox.bluesnap.com/services/2/report/dynamic-def/{report ID}</span>\n\n<hr>\n\n## Documentation\nThis request allows you to retrieve the details of a custom report. \n\n### Request Content\nEnter the report's ID in the request URL, as follows: \n\n`services/2/report/dynamic-def/{report ID}`\n\nFor example: `services/2/report/dynamic-def/12141`\n\nNo content is required in the request body. \n\n### Response Details \nIf successful, the response HTTP status code is 200 OK.\nThe response contains the retrieved **[customReport](doc:custom-report-object)** object. \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-def/7637 \\\\\\n-H 'Content-Type: application/json' \\\\\\n-H 'Accept: application/json' \\\\ \\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\",\n \"language\": \"curl\",\n \"name\": \"Retrieve Custom Report\"\n }\n ]\n}\n[/block]\n### Response Examples \n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"{\\n \\\"id\\\": 7637,\\n \\\"category\\\": \\\"TransactionCategory\\\",\\n \\\"title\\\": \\\"Transaction Report 1\\\",\\n \\\"info\\\": \\\"My custom transaction report\\\",\\n \\\"columns\\\": [\\n {\\n \\\"name\\\": \\\"Merchant Sales (Auth Currency)\\\"\\n },\\n {\\n \\\"name\\\": \\\"Auth. Currency\\\"\\n },\\n {\\n \\\"name\\\": \\\"Merchant Transaction ID\\\"\\n },\\n {\\n \\\"name\\\": \\\"Transaction Date\\\"\\n },\\n {\\n \\\"name\\\": \\\"Transaction Type\\\"\\n }\\n ]\\n}\",\n \"language\": \"json\",\n \"name\": \"200 OK\"\n }\n ]\n}\n[/block]","updates":[],"order":3,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5fa18d8e64ee8f00123f8412","createdAt":"2020-11-03T17:04:14.723Z","user":"5ea72d649148ff00653f6bbc","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Custom Reporting API","slug":"dynamic-reporting-api","order":2,"from_sync":false,"reference":false,"_id":"5fa18956dd369d003cb51fc6","createdAt":"2020-11-03T16:46:14.694Z","version":"5fa1893ed2a2370028d24282","project":"57336fd5a6a9c40e00e13a0b","__v":0},"version":{"version":"8976-Tools","version_clean":"8976.0.0-Tools","codename":"3.36 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5fa1893ed2a2370028d2421e","5fa1893ed2a2370028d2421f","5fa1893ed2a2370028d24220","5fa1893ed2a2370028d24221","5fa1893ed2a2370028d24222","5fa1893ed2a2370028d24223","5fa1893ed2a2370028d24224","5fa1893ed2a2370028d24225","5fa1893ed2a2370028d24226","5fa1893ed2a2370028d24227","5fa1893ed2a2370028d24228","5fa1893ed2a2370028d24229","5b34c737e0dca2000311de6a","5fa1893ed2a2370028d2422a","5fa1893ed2a2370028d2422b","5fa1893ed2a2370028d2422c","5fa1893ed2a2370028d2422d","5fa1893ed2a2370028d2422e","5fa1893ed2a2370028d2422f","5fa18956dd369d003cb51fc6"],"_id":"5fa1893ed2a2370028d24282","project":"57336fd5a6a9c40e00e13a0b","__v":1,"forked_from":"5f4d276c4ff932005f3e3b86","createdAt":"2018-04-23T15:17:35.680Z","releaseDate":"2018-04-23T15:17:35.680Z"},"project":"57336fd5a6a9c40e00e13a0b","__v":0,"parentDoc":null}
getRetrieve Custom Report
Definition
https://sandbox.bluesnap.com/services/2/report/dynamic-def/{report ID}
Documentation
This request allows you to retrieve the details of a custom report.
Request Content
Enter the report's ID in the request URL, as follows:
services/2/report/dynamic-def/{report ID}
For example: services/2/report/dynamic-def/12141
No content is required in the request body.
Response Details
If successful, the response HTTP status code is 200 OK.
The response contains the retrieved customReport object.
Examples
Request Examples
curl -v -X GET https://sandbox.bluesnap.com/services/2/report/dynamic-def/7637 \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
-d '
{
"id": 7637,
"category": "TransactionCategory",
"title": "Transaction Report 1",
"info": "My custom transaction report",
"columns": [
{
"name": "Merchant Sales (Auth Currency)"
},
{
"name": "Auth. Currency"
},
{
"name": "Merchant Transaction ID"
},
{
"name": "Transaction Date"
},
{
"name": "Transaction Type"
}
]
}