{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","settings":"","results":{"codes":[]},"params":[],"examples":{"codes":[]},"method":"get"},"next":{"description":"","pages":[]},"title":"Retrieve All Custom Reports","type":"endpoint","slug":"retrieve-all-custom-reports","excerpt":"","body":"## Definition\nhttps<span>://sandbox.bluesnap.com/services/2/report/dynamic-def</span>\n\n<hr>\n\n## Documentation\nThis request allows you to retrieve all your custom reports. \n\n### Request Content\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 an array of **[customReport](doc:custom-report-object)** objects. \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 \\\\\\n-H 'Content-Type: application/json' \\\\\\n-H 'Accept: application/json' \\\\ \\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \\\\\\n-d '\",\n      \"language\": \"curl\",\n      \"name\": \"Retrieve All Custom Reports\"\n    }\n  ]\n}\n[/block]\n### Response Examples \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"[\\n  {\\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  {\\n    \\\"id\\\": 7641,\\n    \\\"category\\\": \\\"PayoutCategory\\\",\\n    \\\"title\\\": \\\"My custom payout report\\\",\\n    \\\"columns\\\": [\\n      {\\n        \\\"name\\\": \\\"Merchant Transaction ID\\\"\\n      },\\n      {\\n        \\\"name\\\": \\\"Transaction Amount\\\"\\n      },\\n      {\\n        \\\"name\\\": \\\"Transaction Currency\\\"\\n      },\\n      {\\n        \\\"name\\\": \\\"Gross Payout Amount\\\"\\n      },\\n      {\\n        \\\"name\\\": \\\"Payment ID\\\"\\n      }\\n    ]\\n  }\\n]\",\n      \"language\": \"json\",\n      \"name\": \"200 OK\"\n    }\n  ]\n}\n[/block]","updates":[],"order":4,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"603fec227146110018e1daa6","createdAt":"2020-11-03T17:05:06.489Z","user":"5ea72d649148ff00653f6bbc","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Custom Reporting API","slug":"dynamic-reporting-api","order":2,"from_sync":false,"reference":false,"_id":"603fec227146110018e1da4f","createdAt":"2020-11-03T16:46:14.694Z","version":"603fec227146110018e1daaf","project":"57336fd5a6a9c40e00e13a0b","__v":0},"version":{"version":"8976-Tools","version_clean":"8976.0.0-Tools","codename":"3.37 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["603fec227146110018e1da3d","603fec227146110018e1da3e","603fec227146110018e1da3f","603fec227146110018e1da40","603fec227146110018e1da41","603fec227146110018e1da42","603fec227146110018e1da43","603fec227146110018e1da44","603fec227146110018e1da45","603fec227146110018e1da46","603fec227146110018e1da47","603fec227146110018e1da48","5b34c737e0dca2000311de6a","603fec227146110018e1da49","603fec227146110018e1da4a","603fec227146110018e1da4b","603fec227146110018e1da4c","603fec227146110018e1da4d","603fec227146110018e1da4e","603fec227146110018e1da4f"],"_id":"603fec227146110018e1daaf","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"6019bc72944282005e966fd4","createdAt":"2018-04-23T15:17:35.680Z","releaseDate":"2018-04-23T15:17:35.680Z"},"project":"57336fd5a6a9c40e00e13a0b","__v":0,"parentDoc":null}

getRetrieve All Custom Reports


Definition

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


Documentation

This request allows you to retrieve all your custom reports.

Request Content

No content is required in the request body.

Response Details

If successful, the response HTTP status code is 200 OK.
The response contains an array of customReport objects.


Examples

Request Examples

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

Response Examples

[
  {
    "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"
      }
    ]
  },
  {
    "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"
      }
    ]
  }
]