{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","settings":"","results":{"codes":[]},"params":[]},"next":{"description":"","pages":[]},"title":"Custom Reporting API Overview","type":"basic","slug":"custom-reporting-api-overview","excerpt":"","body":"BlueSnap's Custom Reporting API is a RESTful web service that enables you to create, manage, and run your own reports. You start with one of the [available report categories](doc:report-categories) and select the columns you want to include. For example, you might wish to create a custom transaction report that only includes the columns Merchant Transaction ID, transaction amount, currency, and date. \n\n## API web services\nThese are the core web services in the Custom Reporting API. \n\nTo manage your reports, see: \n\n* [Create Custom Report](doc:create-custom-report) \n* [Update Custom Report](doc:update-custom-report) \n* [Retrieve Custom Report](doc:retrieve-custom-report) \n* [Retrieve All Custom Reports](doc:retrieve-all-custom-reports) \n* [Delete Custom Report](doc:delete-custom-report) \n\nTo run your reports, see:\n\n* [Run Custom Report](doc:run-custom-report)\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"If you're using our Custom Reporting API, you can pull a single, unified report for multiple merchant IDs (MIDs) by including the `merchantIds` parameter in your API request. You can find more information about the `merchantIds` parameter under [Query Parameter Descriptions](https://developers.bluesnap.com/v8976-Tools/docs/query-parameters#section-parameter-descriptions).\\n\\nThe `merchantIDs` parameter allows you to pull reports with multiple MIDs, whether you are a partner with multiple merchants or a merchant with multiple MIDs.\",\n  \"title\": \"Pulling a Single Report for Multiple Merchant IDs\"\n}\n[/block]\n## API base URLs\nThese are the base URLs for the BlueSnap environments.\n* Sandbox: `https://sandbox.bluesnap.com`\n* Production: `https://ws.bluesnap.com`\n\n## Authentication\nEvery API request must be authenticated using an [HTTP Basic Authentication header](/docs/authentication#section-authentication).\n\n## API credentials\nIf you do not yet have API credentials, follow [these steps](/docs/api-credentials) to obtain them.","updates":[],"order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"6197defc41c8040154bcbac5","createdAt":"2020-11-03T16:46:36.876Z","user":"5ea72d649148ff00653f6bbc","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Custom Reporting API","slug":"dynamic-reporting-api","order":2,"from_sync":false,"reference":false,"_id":"6197defc41c8040154bcba72","createdAt":"2020-11-03T16:46:14.694Z","version":"6197defc41c8040154bcbaea","project":"57336fd5a6a9c40e00e13a0b","__v":0},"version":{"version":"8976-Tools","version_clean":"8976.0.0-Tools","codename":"3.40 Release","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["6197defc41c8040154bcba61","6197defc41c8040154bcba62","6197defc41c8040154bcba63","6197defc41c8040154bcba64","6197defc41c8040154bcba65","6197defc41c8040154bcba66","6197defc41c8040154bcba67","6197defc41c8040154bcba68","6197defc41c8040154bcba69","6197defc41c8040154bcba6a","6197defc41c8040154bcba6b","6197defc41c8040154bcba6c","5b34c737e0dca2000311de6a","60957f4cce403c0045a031ef","6197defc41c8040154bcba6d","6197defc41c8040154bcba6e","6197defc41c8040154bcba6f","6197defc41c8040154bcba70","6197defc41c8040154bcba71","6197defc41c8040154bcba72"],"_id":"6197defc41c8040154bcbaea","project":"57336fd5a6a9c40e00e13a0b","__v":0,"forked_from":"60957f4cce403c0045a03255","createdAt":"2018-04-23T15:17:35.680Z","releaseDate":"2018-04-23T15:17:35.680Z"},"project":"57336fd5a6a9c40e00e13a0b","__v":0,"parentDoc":null}

Custom Reporting API Overview


BlueSnap's Custom Reporting API is a RESTful web service that enables you to create, manage, and run your own reports. You start with one of the available report categories and select the columns you want to include. For example, you might wish to create a custom transaction report that only includes the columns Merchant Transaction ID, transaction amount, currency, and date.

API web services

These are the core web services in the Custom Reporting API.

To manage your reports, see:

To run your reports, see:

Pulling a Single Report for Multiple Merchant IDs

If you're using our Custom Reporting API, you can pull a single, unified report for multiple merchant IDs (MIDs) by including the merchantIds parameter in your API request. You can find more information about the merchantIds parameter under Query Parameter Descriptions.

The merchantIDs parameter allows you to pull reports with multiple MIDs, whether you are a partner with multiple merchants or a merchant with multiple MIDs.

API base URLs

These are the base URLs for the BlueSnap environments.

  • Sandbox: https://sandbox.bluesnap.com
  • Production: https://ws.bluesnap.com

Authentication

Every API request must be authenticated using an HTTP Basic Authentication header.

API credentials

If you do not yet have API credentials, follow these steps to obtain them.