{"_id":"5addf90f94fe9d0003cd9d36","category":{"_id":"5addf90f94fe9d0003cd9d2b","version":"5addf90f94fe9d0003cd9d29","project":"57336fd5a6a9c40e00e13a0b","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-04-21T12:52:47.551Z","from_sync":false,"order":1,"slug":"reporting-api","title":"Reporting API"},"parentDoc":null,"user":"560d5913af97231900938124","project":"57336fd5a6a9c40e00e13a0b","version":{"_id":"5addf90f94fe9d0003cd9d29","project":"57336fd5a6a9c40e00e13a0b","__v":1,"createdAt":"2018-04-23T15:17:35.680Z","releaseDate":"2018-04-23T15:17:35.680Z","categories":["5addf90f94fe9d0003cd9d2a","5addf90f94fe9d0003cd9d2b","5addf90f94fe9d0003cd9d2c","5addf90f94fe9d0003cd9d2d","5addf90f94fe9d0003cd9d2e","5addf90f94fe9d0003cd9d2f","5addf90f94fe9d0003cd9d30","5addf90f94fe9d0003cd9d31","5addf90f94fe9d0003cd9d32","5addf90f94fe9d0003cd9d33","5addf90f94fe9d0003cd9d34"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"3.25.1 Release","version_clean":"8976.0.0-Tools","version":"8976-Tools"},"__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-04-21T17:23:39.263Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"get","results":{"codes":[{"code":"","language":"text"}]},"settings":"","auth":"optional","params":[],"url":""},"isReference":false,"order":2,"body":"##Definition\nhttps<span>://sandbox.bluesnap.com/services/2/report/{report_code}?{parameters}</span>\n\n<hr>\n\n##Documentation\nUse this GET request to retrieve report data in either JSON or CSV format.\n\n###Request Content\nThis is the basic request format for each BlueSnap environment:\n* Sandbox: `https://sandbox.bluesnap.com/services/2/report/{report_code}?{parameters}`\n* Production: `https://ws.bluesnap.com/services/2/report/{report_code}?{parameters}`\n\nInsert the report code for the type of report that you want to retrieve, plus the relevant parameters.\n\nFor example: \n`https://sandbox.bluesnap.com/services/2/report/TransactionDetail?period=LAST_MONTH&skuType=ONE_TIME&transactionType=SALE\n&paymentType=Credit%20Card&products=281272&contracts=2117474&pageSize=2`\n<br>\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"There is currently a time delay of 2-3 hours for report data, meaning that you will not see data for transactions that took place within the last 3 hours.\",\n  \"title\": \"Report Availablity\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"Tips\",\n  \"body\": \"**Parsing report data**\\nParse report data based on parameter name to ensure your integration continues to work properly when reports are updated (such as when the parameter order changes). This is because parameters are never renamed or removed. \\n\\n**Retrieving payout reports for reconciliation**\\nRetrieve the Payout Detail and Payout Summary reports after you receive the [`payout` IPN](https://support.bluesnap.com/docs/about-ipns), as the IPN is sent when your deposits have been finalized.\"\n}\n[/block]\n**Report codes**\nThese are the supported report types. In the request, include the code for the report you want to retrieve.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Report code\",\n    \"h-1\": \"Description\",\n    \"6-1\": \"Provides a list of declined credit and debit card transactions with decline reason, payment details, and shopper information. [Learn more](https://support.bluesnap.com/docs/declined-transactions)\",\n    \"6-0\": \"`DeclinedTransactions`\",\n    \"1-0\": \"`ActiveSubscriptions`\",\n    \"1-1\": \"Provides details about active subscriptions, such as the next charge date, Subscription ID, and shopper info. [Learn more](https://support.bluesnap.com/docs/active-subscriptions)\",\n    \"12-0\": \"`VendorDetails`\",\n    \"12-1\": \"Provides account details for each of the vendors in your marketplace. [Learn more](https://support.bluesnap.com/docs/vendor-details)\",\n    \"7-0\": \"`DirectDebit`\",\n    \"7-1\": \"Provides a list of all ACH / Electronic Check and SEPA Direct Debit transactions. Use this report to track the invoice status from Pending to Approved or Canceled. [Learn more](https://support.bluesnap.com/docs/achdirect-debit-report)\",\n    \"8-0\": \"`PayoutDetail`\",\n    \"8-1\": \"Provides details about the transactions included in BlueSnap deposits to your account. \\n[Learn more](https://support.bluesnap.com/docs/payout-detail)\",\n    \"0-0\": \"`AccountBalance`\",\n    \"0-1\": \"Provides details about your current account balance (amount that has not been paid out yet), including  payout currency(ies), gross and net amounts, and more. [Learn more](https://support.bluesnap.com/docs/account-balance)\",\n    \"2-0\": \"`AU_BluesnapVaultCards`\",\n    \"2-1\": \"Provides the results of your Account Updater requests. This report is designed for merchants who use* BlueSnap's* card vault to store credit card numbers. [Learn more](https://support.bluesnap.com/docs/account-updater-bluesnap-vault-cards)\",\n    \"3-0\": \"`AU_MerchantVaultCards`\",\n    \"3-1\": \"Provides the results of your Account Updater requests. This report is designed for merchants who vault credit card numbers on ***their own*** servers. [Learn more](https://support.bluesnap.com/docs/account-updater-merchant-vault-cards)\",\n    \"4-0\": \"`CanceledSubscriptions`\",\n    \"4-1\": \"Provides a list of canceled subscriptions that include the plan, shopper, and cancellation details. [Learn more](https://support.bluesnap.com/docs/canceled-subscriptions)\",\n    \"11-0\": \"`TransactionDetail`\",\n    \"11-1\": \"Provides details about each transaction, including shopper info, payment details, subscription info and more. [Learn more](https://support.bluesnap.com/docs/transaction-detail)\",\n    \"9-0\": \"`PayoutSummary`\",\n    \"9-1\": \"The Payout Summary report has all the information you need to reconcile your gross sales with the amount deposited into your bank account for each payout currency. It includes all sales, refunds, chargebacks, non-processing fees and any other adjustments to your account. [Learn more](https://support.bluesnap.com/docs/payout-summary)\",\n    \"5-0\": \"`DeclinedAuths`\",\n    \"5-1\": \"Provides a list of all declined authorizations and the fees for those that have been charged. [Learn more](https://support.bluesnap.com/docs/declined-authorizations-detailed-report)\",\n    \"10-0\": \"`StoppedFraud`\",\n    \"10-1\": \"Provides details about transactions that were declined because of your fraud rules or BlueSnap's fraud detection logic. [Learn more](https://support.bluesnap.com/docs/stopped-fraud-report)\"\n  },\n  \"cols\": 2,\n  \"rows\": 13\n}\n[/block]\n**Query parameters**\nThese are the supported query parameters per report type.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Value\",\n    \"h-2\": \"Example\",\n    \"3-0\": \"`format`\",\n    \"8-0\": \"`pageSize`\",\n    \"2-0\": \"`currency`\",\n    \"13-0\": \"`period`\\n\\n<span style=\\\"color:#F38A00\\\">**required**</span>; Optional for PayoutDetail\",\n    \"13-1\": \"**THIS_MONTH**\\n**LAST_WEEK**\\n**LAST_MONTH** **LAST_3_MONTHS**\\n**LAST_6_MONTHS**\\n**LAST_12_MONTHS**\\n**CUSTOM** - for a custom period, you must also include the **from_date** and **to_date** parameters (format is MM/DD/YYYY or YYYY-MM-DD)\",\n    \"2-1\": \"Three-letter currency code (uppercase)\",\n    \"2-2\": \"`currency=USD`\",\n    \"13-2\": \"`period=LAST_3_MONTHS`\\n\\nperiod=CUSTOM\\n&from_date=01/30/2016\\n&to_date=03/30/2016\",\n    \"14-0\": \"`products`\",\n    \"0-0\": \"`accountUpdaterStatus`\",\n    \"0-1\": \"**A **(acknowledged) \\n**C **(completed) \\nBlank (returns A & C)\",\n    \"14-1\": \"Number or a comma-separated list of numbers\\n\\nIf not defined, data is returned for all products\",\n    \"0-2\": \"`accountUpdaterStatus=A`\",\n    \"14-2\": \"`products=444555`\",\n    \"15-0\": \"`skuType`\",\n    \"15-1\": \"**ONE_TIME**\\n**RECURRING**\",\n    \"9-0\": \"`paymentType`\",\n    \"9-2\": \"`paymentType=Credit Card`\",\n    \"9-1\": \"Screen the sales by the payment method:\\n\\nDeclinedTransactions report\\n**Apple Pay\\nCredit Card**\\n\\nTransactionDetail report\\n**Alipay\\nApple Pay\\nBalance\\nBoleto Bancario\\nBusiness Check\\nCashier Check\\nCredit Card\\nDirect Debit\\nElectronic Check\\nGlobalCollect Cheque\\nLocal Bank Transfer\\nMoney Order\\nNone\\nOffline Electronic Check\\nOnline banking\\nPayPal\\nPaySafeCard\\nPersonal Check\\nPurchase Order\\nSEPA Direct Debit\\nSkrill (Moneybookers)\\nWallie\\nWebMoney\\nWire Transfer**\",\n    \"16-0\": \"`transactionType`\",\n    \"16-1\": \"**SALE\\nREFUND\\nCHARGEBACK**\",\n    \"16-2\": \"`transactionType=SALE`\",\n    \"15-2\": \"`skuType=ONE_TIME`\",\n    \"3-1\": \"**csv**\\n\\nBy default, the response is in JSON. If you would like to receive the data in CSV format, use the `format` parameter and set the value to **csv**.\",\n    \"8-1\": \"Number of rows in the response page.\\n\\nIf not specified, each page will contain a maximum of 10,000 rows\\n\\nRelevant only for the first page call\",\n    \"3-2\": \"`format=csv`\",\n    \"h-3\": \"Report Types\",\n    \"13-3\": \"AccountBalance\\nActiveSubscriptions\\nAU_BluesnapVaultCards\\nAU_MerchantVaultCards\\nCanceledSubscriptions\\nDeclinedAuths\\nDeclinedTransactions\\nDirectDebit\\nPayoutSummary\\nPayoutDetail\\nStoppedFraud\\nTransactionDetail\",\n    \"0-3\": \"AU_MerchantVaultCards\",\n    \"2-3\": \"ActiveSubscriptions\\nCanceledSubscriptions\\nDeclinedAuths\\nPayoutDetail\\nPayoutSummary\\nTransactionDetail\",\n    \"3-3\": \"All reports\",\n    \"8-3\": \"ActiveSubscriptions\\nAU_BluesnapVaultCards\\nAU_MerchantVaultCards\\nCanceledSubscriptions\\nDeclinedAuths\\nDeclinedTransactions\\nPayoutDetail\\nStopped Fraud \\nTransactionDetail\",\n    \"9-3\": \"DeclinedTransactions \\nTransactionDetail\",\n    \"14-3\": \"ActiveSubscriptions\\nCanceledSubscriptions\\nTransactionDetail\",\n    \"15-3\": \"TransactionDetail\",\n    \"16-3\": \"TransactionDetail\",\n    \"1-0\": \"`contracts`\",\n    \"1-1\": \"Number or a comma-separated list of numbers\\n\\nIf not defined, data is returned for all contracts under the specified product\\n\\nTo use this, you must also include the `products` parameter\",\n    \"1-2\": \"`contracts=123456,987612`\",\n    \"1-3\": \"ActiveSubscriptions\\nCanceledSubscriptions\\nTransactionDetail\",\n    \"6-0\": \"`merchantBatchId`\",\n    \"6-3\": \"AU_MerchantVaultCards\",\n    \"6-1\": \"A merchant generated alphanumeric string\",\n    \"6-2\": \"`merchantBatchId=B_12ed121aa`\",\n    \"7-0\": \"`merchantUpdaterId`\",\n    \"7-1\": \"A merchant generated alphanumeric string\",\n    \"7-2\": \"`merchantUpdaterId=4564106_1`\",\n    \"7-3\": \"AU_MerchantVaultCards\",\n    \"11-0\": \"`payoutCycle`\",\n    \"11-2\": \"`payoutCycle=2016D303`\",\n    \"11-1\": \"A BlueSnap assigned value identifying the payout cycle\",\n    \"11-3\": \"DeclinedAuths\\nPayoutDetail\\nPayoutSummary\",\n    \"19-0\": \"`vendor`\",\n    \"19-1\": \"Vendor ID, a unique value assigned by BlueSnap to each Marketplace vendor.\",\n    \"19-2\": \"`vendor=123456`\",\n    \"19-3\": \"ActiveSubscriptions\\nCanceledSubscriptions\\nDeclinedAuths\\nDeclinedTransactions\\nDirectDebit\\nTransactionDetail\\nVendorDetails\",\n    \"5-0\": \"`invoiceStatus`\",\n    \"5-1\": \"**Approved**\\n**Canceled**\\n**Pending**\\n**Refunded**\",\n    \"5-2\": \"`invoiceStatus=Approved`\",\n    \"5-3\": \"DirectDebit\",\n    \"18-0\": \"`forvendorid`\",\n    \"18-1\": \"Vendor ID, a unique value assigned by BlueSnap to each Marketplace vendor. \\n\\nParameter is used to retrieve account balance and payout details for vendor.\",\n    \"18-2\": \"`forvendorid=513499`\",\n    \"18-3\": \"AccountBalance\\nPayoutDetail\\nPayoutSummary\",\n    \"20-0\": \"`vendorStatus`\",\n    \"20-1\": \"Vendor's account status. If not defined, data is returned for all statuses. \\n\\n**Active**\\n**Inactive**\",\n    \"20-2\": \"`vendorStatus=Active`\",\n    \"20-3\": \"VendorDetails\",\n    \"17-0\": \"`typeOfTransaction`\",\n    \"17-3\": \"DeclinedAuths\",\n    \"17-1\": \"**Card Verification\\nFailover\\nFree Trial\\nPayment\\nSubscription Free Trial\\nSubscription Recurring Charge\\nSubscription Retry**\\n\\nIf not defined, data is returned for all transaction types.\",\n    \"17-2\": \"`typeOfTransaction=Charge`\",\n    \"4-0\": \"`fraudDeclineReason`\",\n    \"4-1\": \"**AVS/CVV Rules** \\n**Configurable Fraud Thresholds**\\n **BlueSnap Fraud Rules**\\n**Velocity**\",\n    \"4-2\": \"`fraudDeclineReason=Velocity`\",\n    \"4-3\": \"StoppedFraud\",\n    \"12-0\": \"`payoutPlannedDate`\",\n    \"12-1\": \"The date a payment is expected to be initiated according to your payout schedule. If the Planned Date falls on a weekend or bank holiday, the payment will be initiated on the next business day.\",\n    \"12-3\": \"\",\n    \"10-0\": \"`payoutCurrency`\",\n    \"10-1\": \"3-digit code of the currency of the bank account where you will receive proceeds from the transaction.\",\n    \"10-2\": \"`payoutCurrency=USD`\",\n    \"10-3\": \"PayoutDetail\\nPayoutSummary\"\n  },\n  \"cols\": 4,\n  \"rows\": 21\n}\n[/block]\n**Paging**\nTo define the limit on the number of rows returned per page, use the `pageSize` parameter in the first request. For example:\n`https://sandbox.bluesnap.com/services/2/report/TransactionDetail?period=LAST_WEEK&pageSize=5`\n\nIf you do not specify a page size, the maximum size is 10,000 rows by default.\n\nThe response will include a header with the `next-page-token`, and will indicate the start row of the current response, as well as the total number of rows. For example:\n\n    next-page-token: bmV4dHBhZ2V0b2tlbg==\n    start-row: 1\n    total-row-count: 3019\n\nInsert the `next-page-token` in the request to call the next page of results. Optionally, you can also include the `format` parameter. No other parameters are required. For example:\n\n`https://sandbox.bluesnap.com/services/2/report/TransactionDetail?nextPageToken=bmV4dHBhZ2V0b2tlbg==&format=csv`\n\nThe last page of results will not return the `next-page-token` header.\n\n### Response Details \nIf successful, the HTTP status code is 200 OK. The report data is included in the `data` property. For details on any of the report parameters, see [BlueSnap Reporting](https://support.bluesnap.com/docs/reporting#section-available-reports). \n\n**Error Handling**\nFor information about possible errors, see [Errors](doc:reporting-api-errors).\n\n<a class=\"btn btn-primary\" href=\"#\" role=\"button\">Back to Top</a>\n\n##Examples\n\n###Request Examples\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -v -X GET https://sandbox.bluesnap.com/services/2/report/TransactionDetail?period=CUSTOM&from_date=01%2F01%2F2016&to_date=03%2F31%2F2016&skuType=ONE_TIME&transactionType=SALE&paymentType=Credit%20Card&products=281272&contracts=2117474&pageSize=2 \\\\\\n-H 'Content-Type: application/json' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='\",\n      \"language\": \"curl\",\n      \"name\": \"Get Transaction Detail report - first page\"\n    },\n    {\n      \"code\": \"curl -v -X GET https://sandbox.bluesnap.com/services/2/report/TransactionDetail?nextPageToken=bmV4dHBhZ2V0b2tlbg== \\\\\\n-H 'Content-Type: application/json' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='\",\n      \"language\": \"curl\",\n      \"name\": \"Get Transaction Detail report - next page\"\n    },\n    {\n      \"code\": \"curl -v -X GET https://sandbox.bluesnap.com/services/2/report/AccountBalance?period=THIS_MONTH \\\\\\n-H 'Content-Type: application/json' \\\\\\n-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='\",\n      \"language\": \"curl\",\n      \"name\": \"Get Account Balance Report \"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"###Response Examples\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"next-page-token: bmV4dHBhZ2V0b2tlbg==\\npage-size →2\\nstart-row →1\\ntotal-row-count →72\\n\\n{\\n  \\\"data\\\": [\\n    {\\n      \\\"Payment ID\\\": \\\"0\\\",\\n      \\\"Invoice ID\\\": \\\"1006677339\\\",\\n      \\\"Original Invoice ID\\\": \\\"1006677339\\\",\\n      \\\"Transaction Type\\\": \\\"Sale\\\",\\n      \\\"Transaction Date\\\": \\\"03/30/2016\\\",\\n      \\\"Purchase Date\\\": \\\"\\\",\\n      \\\"Refund / Chargeback Reason\\\": \\\"\\\",\\n      \\\"Product\\\": \\\"Laptop\\\",\\n      \\\"Product ID\\\": \\\"281272\\\",\\n      \\\"Contract\\\": \\\"Lenovo G550\\\",\\n      \\\"Contract ID\\\": \\\"2117474\\\",\\n      \\\"SKU Type\\\": \\\"One-time contract\\\",\\n      \\\"Payment Frequency\\\": \\\"Once\\\",\\n      \\\"Recurring Cycle Group\\\": \\\"First Time\\\",\\n      \\\"Recurring Cycle Number\\\": \\\"1\\\",\\n      \\\"Payment Type\\\": \\\"Credit Card\\\",\\n      \\\"Card Network\\\": \\\"Visa\\\",\\n      \\\"Qty\\\": \\\"1\\\",\\n      \\\"Auth. Currency\\\": \\\"USD\\\",\\n      \\\"Merchant Sales (Auth Currency)\\\": \\\"22.00\\\",\\n      \\\"Merchant Sales (Base Currency)\\\": \\\"22.00\\\",\\n      \\\"Shopper ID\\\": \\\"20081653\\\",\\n      \\\"Shopper First Name\\\": \\\"Shopper  first name\\\",\\n      \\\"Shopper Last Name\\\": \\\"Shopper last name\\\",\\n      \\\"Shopper Email\\\": \\\"john.smith:::at:::gmail.com\\\",\\n      \\\"Shopper Country\\\": \\\"United States\\\",\\n      \\\"Custom Field 1\\\": \\\"\\\",\\n      \\\"Custom Field 2\\\": \\\"\\\",\\n      \\\"Custom Field 3\\\": \\\"N\\\",\\n      \\\"Custom Field 4\\\": \\\"\\\",\\n      \\\"Custom Field 5\\\": \\\"\\\",\\n      \\\"Custom Field 6\\\": \\\"\\\",\\n      \\\"Custom Field 7\\\": \\\"\\\",\\n      \\\"Custom Field 8\\\": \\\"\\\",\\n      \\\"Custom Field 9\\\": \\\"\\\",\\n      \\\"Custom Field 10\\\": \\\"\\\"\\n    },\\n    {\\n      \\\"Payment ID\\\": \\\"0\\\",\\n      \\\"Invoice ID\\\": \\\"1006677341\\\",\\n      \\\"Original Invoice ID\\\": \\\"1006677341\\\",\\n      \\\"Transaction Type\\\": \\\"Sale\\\",\\n      \\\"Transaction Date\\\": \\\"03/30/2016\\\",\\n      \\\"Purchase Date\\\": \\\"\\\",\\n      \\\"Refund / Chargeback Reason\\\": \\\"\\\",\\n      \\\"Product\\\": \\\"Laptop\\\",\\n      \\\"Product ID\\\": \\\"281272\\\",\\n      \\\"Contract\\\": \\\"Lenovo G550\\\",\\n      \\\"Contract ID\\\": \\\"2117474\\\",\\n      \\\"SKU Type\\\": \\\"One-time contract\\\",\\n      \\\"Payment Frequency\\\": \\\"Once\\\",\\n      \\\"Recurring Cycle Group\\\": \\\"First Time\\\",\\n      \\\"Recurring Cycle Number\\\": \\\"1\\\",\\n      \\\"Payment Type\\\": \\\"Credit Card\\\",\\n      \\\"Card Network\\\": \\\"Visa\\\",\\n      \\\"Qty\\\": \\\"1\\\",\\n      \\\"Auth. Currency\\\": \\\"EUR\\\",\\n      \\\"Merchant Sales (Auth Currency)\\\": \\\"72.71\\\",\\n      \\\"Merchant Sales (Base Currency)\\\": \\\"99.99\\\",\\n      \\\"Shopper ID\\\": \\\"20081655\\\",\\n      \\\"Shopper First Name\\\": \\\"Vitaly\\\",\\n      \\\"Shopper Last Name\\\": \\\"Fligel\\\",\\n      \\\"Shopper Email\\\": \\\"test@test.com\\\",\\n      \\\"Shopper Country\\\": \\\"United States\\\",\\n      \\\"Custom Field 1\\\": \\\"\\\",\\n      \\\"Custom Field 2\\\": \\\"\\\",\\n      \\\"Custom Field 3\\\": \\\"N\\\",\\n      \\\"Custom Field 4\\\": \\\"\\\",\\n      \\\"Custom Field 5\\\": \\\"\\\",\\n      \\\"Custom Field 6\\\": \\\"\\\",\\n      \\\"Custom Field 7\\\": \\\"\\\",\\n      \\\"Custom Field 8\\\": \\\"\\\",\\n      \\\"Custom Field 9\\\": \\\"\\\",\\n      \\\"Custom Field 10\\\": \\\"\\\"\\n    }\\n  ],\\n  \\\"title\\\": \\\"Transaction Detail\\\",\\n  \\\"params\\\": [\\n    {\\n      \\\"name\\\": \\\"Period\\\",\\n      \\\"value\\\": \\\"CUSTOM\\\"\\n    },\\n    {\\n      \\\"name\\\": \\\"From date\\\",\\n      \\\"value\\\": \\\"01/01/2016\\\"\\n    },\\n    {\\n      \\\"name\\\": \\\"To date\\\",\\n      \\\"value\\\": \\\"03/31/2016\\\"\\n    },\\n    {\\n      \\\"name\\\": \\\"SKU Type\\\",\\n      \\\"value\\\": \\\"ONE_TIME\\\"\\n    },\\n    {\\n      \\\"name\\\": \\\"Transaction Type\\\",\\n      \\\"value\\\": \\\"SALE\\\"\\n    },\\n    {\\n      \\\"name\\\": \\\"Payment type\\\",\\n      \\\"value\\\": \\\"Credit Card\\\"\\n    },\\n    {\\n      \\\"name\\\": \\\"Products\\\",\\n      \\\"value\\\": \\\"281272\\\"\\n    },\\n    {\\n      \\\"name\\\": \\\"Contracts\\\",\\n      \\\"value\\\": \\\"2117474\\\"\\n    },\\n    {\\n      \\\"name\\\": \\\"Merchant Id\\\",\\n      \\\"value\\\": \\\"382526\\\"\\n    }\\n  ],\\n  \\\"date_range\\\": \\\"01/01/2016 - 03/31/2016\\\",\\n  \\\"base-currency\\\": \\\"USD\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Transaction Detail Report: 200 OK - JSON\"\n    },\n    {\n      \"code\": \"{\\n\\\"data\\\":[\\n{\\\"Payment ID\\\":\\\"0\\\",\\\"Invoice ID\\\":\\\"1006650575\\\",\\\"Original Invoice ID\\\":\\\"1006650575\\\",\\\"Transaction Type\\\":\\\"Sale\\\",\\\"Transaction Date\\\":\\\"03/17/2016\\\",\\\"Purchase Date\\\":\\\"\\\",\\\"Refund / Chargeback Reason\\\":\\\"\\\",\\\"Product\\\":\\\"Laptop\\\",\\\"Product ID\\\":\\\"281272\\\",\\\"Contract\\\":\\\"Lenovo G550\\\",\\\"Contract ID\\\":\\\"2117474\\\",\\\"SKU Type\\\":\\\"One-time contract\\\",\\\"Payment Frequency\\\":\\\"Once\\\",\\\"Recurring Cycle Group\\\":\\\"First Time\\\",\\\"Recurring Cycle Number\\\":\\\"1\\\",\\\"Payment Type\\\":\\\"Credit Card\\\",\\\"Card Network\\\":\\\"Visa\\\",\\\"Qty\\\":\\\"1\\\",\\\"Auth. Currency\\\":\\\"USD\\\",\\\"Merchant Sales (Auth Currency)\\\":\\\"99.99\\\",\\\"Merchant Sales (USD)\\\":\\\"99.99\\\",\\\"Shopper ID\\\":\\\"20059723\\\",\\\"Shopper First Name\\\":\\\"Shopper first name\\\",\\\"Shopper Last Name\\\":\\\"Shopper last name\\\",\\\"Shopper Email\\\":\\\"john.smith@gmail.com\\\",\\\"Shopper Country\\\":\\\"United States\\\",\\\"Custom Field 1\\\":\\\"\\\",\\\"Custom Field 2\\\":\\\"\\\",\\\"Custom Field 3\\\":\\\"N\\\",\\\"Custom Field 4\\\":\\\"\\\",\\\"Custom Field 5\\\":\\\"\\\",\\\"Custom Field 6\\\":\\\"\\\",\\\"Custom Field 7\\\":\\\"\\\",\\\"Custom Field 8\\\":\\\"\\\",\\\"Custom Field 9\\\":\\\"\\\",\\\"Custom Field 10\\\":\\\"\\\"},\\n{\\\"Payment ID\\\":\\\"0\\\",\\\"Invoice ID\\\":\\\"1006650577\\\",\\\"Original Invoice ID\\\":\\\"1006650575\\\",\\\"Transaction Type\\\":\\\"Refund\\\",\\\"Transaction Date\\\":\\\"03/17/2016\\\",\\\"Purchase Date\\\":\\\"03/17/2016\\\",\\\"Refund / Chargeback Reason\\\":\\\"test\\\",\\\"Product\\\":\\\"Laptop\\\",\\\"Product ID\\\":\\\"281272\\\",\\\"Contract\\\":\\\"Lenovo G550\\\",\\\"Contract ID\\\":\\\"2117474\\\",\\\"SKU Type\\\":\\\"One-time contract\\\",\\\"Payment Frequency\\\":\\\"Once\\\",\\\"Recurring Cycle Group\\\":\\\"One Time\\\",\\\"Payment Type\\\":\\\"Credit Card\\\",\\\"Card Network\\\":\\\"Visa\\\",\\\"Qty\\\":\\\"-1\\\",\\\"Auth. Currency\\\":\\\"USD\\\",\\\"Merchant Sales (Auth Currency)\\\":\\\"-99.99\\\",\\\"Merchant Sales (USD)\\\":\\\"-99.99\\\",\\\"Shopper ID\\\":\\\"20059723\\\",\\\"Shopper First Name\\\":\\\"Shopper first name\\\",\\\"Shopper Last Name\\\":\\\"Shopper last name\\\",\\\"Shopper Email\\\":\\\"john.smith@gmail.com\\\",\\\"Shopper Country\\\":\\\"United States\\\",\\\"Custom Field 1\\\":\\\"\\\",\\\"Custom Field 2\\\":\\\"\\\",\\\"Custom Field 3\\\":\\\"N\\\",\\\"Custom Field 4\\\":\\\"\\\",\\\"Custom Field 5\\\":\\\"\\\",\\\"Custom Field 6\\\":\\\"\\\",\\\"Custom Field 7\\\":\\\"\\\",\\\"Custom Field 8\\\":\\\"\\\",\\\"Custom Field 9\\\":\\\"\\\",\\\"Custom Field 10\\\":\\\"\\\"}\\n],\\n\\\"title\\\":\\\"Transaction Detail\\\",\\n\\\"params\\\":[\\n{\\\"name\\\":\\\"Period\\\",\\\"value\\\":\\\"LAST_WEEK\\\"},{\\\"name\\\":\\\"Currency\\\",\\\"value\\\":\\\"\\\"},{\\\"name\\\":\\\"SKU Type\\\",\\\"value\\\":\\\"\\\"},{\\\"name\\\":\\\"Transaction Type\\\",\\\"value\\\":\\\"\\\"},{\\\"name\\\":\\\"Payment type\\\",\\\"value\\\":\\\"\\\"},{\\\"name\\\":\\\"Payment ID\\\",\\\"value\\\":\\\"\\\"},{\\\"name\\\":\\\"Products\\\",\\\"value\\\":\\\"\\\"},{\\\"name\\\":\\\"Merchant Id\\\",\\\"value\\\":\\\"391328\\\"}\\n],\\n\\\"date_range\\\":\\\"01/01/2016 - 03/31/2016\\\"\\n}\",\n      \"language\": \"text\",\n      \"name\": \"Transaction Detail Report: 200 OK - CSV\"\n    },\n    {\n      \"code\": \"{\\n  \\\"data\\\": [\\n    {\\n      \\\"Currency\\\": \\\"USD\\\",\\n      \\\"Total of Gross Amount\\\": \\\"57,622.63\\\",\\n      \\\"Total of Commission Amount\\\": \\\"-1,864.41\\\",\\n      \\\"Affiliates Amount\\\": \\\"0.00\\\",\\n      \\\"Total of Net Amount\\\": \\\"55,758.22\\\",\\n      \\\"Total of Paid by 3rd Party\\\": \\\"-13,227.74\\\",\\n      \\\"Total of Payout Adjustment Amount\\\": \\\"0.00\\\",\\n      \\\"Account Balance\\\": \\\"42,530.48\\\"\\n    }\\n  ],\\n  \\\"title\\\": \\\"Account Balance\\\",\\n  \\\"params\\\": [\\n    {\\n      \\\"name\\\": \\\"Period\\\",\\n      \\\"value\\\": \\\"THIS_MONTH\\\"\\n    },\\n    {\\n      \\\"name\\\": \\\"Merchant Id\\\",\\n      \\\"value\\\": \\\"391328\\\"\\n    }\\n  ],\\n  \\\"date_range\\\": \\\"01/01/2017 - 01/24/2017\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Account Balance Report: 200 OK - JSON\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n<br>\n<a class=\"btn btn-primary\" href=\"#\" role=\"button\">Back to Top</a>","excerpt":"","slug":"get-report-data","type":"endpoint","title":"Get Report Data"}

getGet Report Data


Definition

https://sandbox.bluesnap.com/services/2/report/{report_code}?{parameters}


Documentation

Use this GET request to retrieve report data in either JSON or CSV format.

Request Content

This is the basic request format for each BlueSnap environment:

  • Sandbox: https://sandbox.bluesnap.com/services/2/report/{report_code}?{parameters}
  • Production: https://ws.bluesnap.com/services/2/report/{report_code}?{parameters}

Insert the report code for the type of report that you want to retrieve, plus the relevant parameters.

For example:
https://sandbox.bluesnap.com/services/2/report/TransactionDetail?period=LAST_MONTH&skuType=ONE_TIME&transactionType=SALE &paymentType=Credit%20Card&products=281272&contracts=2117474&pageSize=2

Report Availablity

There is currently a time delay of 2-3 hours for report data, meaning that you will not see data for transactions that took place within the last 3 hours.

Tips

Parsing report data
Parse report data based on parameter name to ensure your integration continues to work properly when reports are updated (such as when the parameter order changes). This is because parameters are never renamed or removed.

Retrieving payout reports for reconciliation
Retrieve the Payout Detail and Payout Summary reports after you receive the payout IPN, as the IPN is sent when your deposits have been finalized.

Report codes
These are the supported report types. In the request, include the code for the report you want to retrieve.

Report code
Description

AccountBalance

Provides details about your current account balance (amount that has not been paid out yet), including payout currency(ies), gross and net amounts, and more. Learn more

ActiveSubscriptions

Provides details about active subscriptions, such as the next charge date, Subscription ID, and shopper info. Learn more

AU_BluesnapVaultCards

Provides the results of your Account Updater requests. This report is designed for merchants who use BlueSnap's card vault to store credit card numbers. Learn more

AU_MerchantVaultCards

Provides the results of your Account Updater requests. This report is designed for merchants who vault credit card numbers on their own servers. Learn more

CanceledSubscriptions

Provides a list of canceled subscriptions that include the plan, shopper, and cancellation details. Learn more

DeclinedAuths

Provides a list of all declined authorizations and the fees for those that have been charged. Learn more

DeclinedTransactions

Provides a list of declined credit and debit card transactions with decline reason, payment details, and shopper information. Learn more

DirectDebit

Provides a list of all ACH / Electronic Check and SEPA Direct Debit transactions. Use this report to track the invoice status from Pending to Approved or Canceled. Learn more

PayoutDetail

Provides details about the transactions included in BlueSnap deposits to your account.
Learn more

PayoutSummary

The Payout Summary report has all the information you need to reconcile your gross sales with the amount deposited into your bank account for each payout currency. It includes all sales, refunds, chargebacks, non-processing fees and any other adjustments to your account. Learn more

StoppedFraud

Provides details about transactions that were declined because of your fraud rules or BlueSnap's fraud detection logic. Learn more

TransactionDetail

Provides details about each transaction, including shopper info, payment details, subscription info and more. Learn more

VendorDetails

Provides account details for each of the vendors in your marketplace. Learn more

Query parameters
These are the supported query parameters per report type.

Parameter
Value
Example
Report Types

accountUpdaterStatus

A (acknowledged)
C (completed)
Blank (returns A & C)

accountUpdaterStatus=A

AU_MerchantVaultCards

contracts

Number or a comma-separated list of numbers

If not defined, data is returned for all contracts under the specified product

To use this, you must also include the products parameter

contracts=123456,987612

ActiveSubscriptions
CanceledSubscriptions
TransactionDetail

currency

Three-letter currency code (uppercase)

currency=USD

ActiveSubscriptions
CanceledSubscriptions
DeclinedAuths
PayoutDetail
PayoutSummary
TransactionDetail

format

csv

By default, the response is in JSON. If you would like to receive the data in CSV format, use the format parameter and set the value to csv.

format=csv

All reports

fraudDeclineReason

AVS/CVV Rules
Configurable Fraud Thresholds
BlueSnap Fraud Rules
Velocity

fraudDeclineReason=Velocity

StoppedFraud

invoiceStatus

Approved
Canceled
Pending
Refunded

invoiceStatus=Approved

DirectDebit

merchantBatchId

A merchant generated alphanumeric string

merchantBatchId=B_12ed121aa

AU_MerchantVaultCards

merchantUpdaterId

A merchant generated alphanumeric string

merchantUpdaterId=4564106_1

AU_MerchantVaultCards

pageSize

Number of rows in the response page.

If not specified, each page will contain a maximum of 10,000 rows

Relevant only for the first page call

ActiveSubscriptions
AU_BluesnapVaultCards
AU_MerchantVaultCards
CanceledSubscriptions
DeclinedAuths
DeclinedTransactions
PayoutDetail
Stopped Fraud
TransactionDetail

paymentType

Screen the sales by the payment method:

DeclinedTransactions report
Apple Pay
Credit Card

TransactionDetail report
Alipay
Apple Pay
Balance
Boleto Bancario
Business Check
Cashier Check
Credit Card
Direct Debit
Electronic Check
GlobalCollect Cheque
Local Bank Transfer
Money Order
None
Offline Electronic Check
Online banking
PayPal
PaySafeCard
Personal Check
Purchase Order
SEPA Direct Debit
Skrill (Moneybookers)
Wallie
WebMoney
Wire Transfer

paymentType=Credit Card

DeclinedTransactions
TransactionDetail

payoutCurrency

3-digit code of the currency of the bank account where you will receive proceeds from the transaction.

payoutCurrency=USD

PayoutDetail
PayoutSummary

payoutCycle

A BlueSnap assigned value identifying the payout cycle

payoutCycle=2016D303

DeclinedAuths
PayoutDetail
PayoutSummary

payoutPlannedDate

The date a payment is expected to be initiated according to your payout schedule. If the Planned Date falls on a weekend or bank holiday, the payment will be initiated on the next business day.

period

required; Optional for PayoutDetail

THIS_MONTH
LAST_WEEK
LAST_MONTH LAST_3_MONTHS
LAST_6_MONTHS
LAST_12_MONTHS
CUSTOM - for a custom period, you must also include the from_date and to_date parameters (format is MM/DD/YYYY or YYYY-MM-DD)

period=LAST_3_MONTHS

period=CUSTOM
&from_date=01/30/2016
&to_date=03/30/2016

AccountBalance
ActiveSubscriptions
AU_BluesnapVaultCards
AU_MerchantVaultCards
CanceledSubscriptions
DeclinedAuths
DeclinedTransactions
DirectDebit
PayoutSummary
PayoutDetail
StoppedFraud
TransactionDetail

products

Number or a comma-separated list of numbers

If not defined, data is returned for all products

products=444555

ActiveSubscriptions
CanceledSubscriptions
TransactionDetail

skuType

ONE_TIME
RECURRING

skuType=ONE_TIME

TransactionDetail

transactionType

SALE
REFUND
CHARGEBACK

transactionType=SALE

TransactionDetail

typeOfTransaction

Card Verification
Failover
Free Trial
Payment
Subscription Free Trial
Subscription Recurring Charge
Subscription Retry

If not defined, data is returned for all transaction types.

typeOfTransaction=Charge

DeclinedAuths

forvendorid

Vendor ID, a unique value assigned by BlueSnap to each Marketplace vendor.

Parameter is used to retrieve account balance and payout details for vendor.

forvendorid=513499

AccountBalance
PayoutDetail
PayoutSummary

vendor

Vendor ID, a unique value assigned by BlueSnap to each Marketplace vendor.

vendor=123456

ActiveSubscriptions
CanceledSubscriptions
DeclinedAuths
DeclinedTransactions
DirectDebit
TransactionDetail
VendorDetails

vendorStatus

Vendor's account status. If not defined, data is returned for all statuses.

Active
Inactive

vendorStatus=Active

VendorDetails

Paging
To define the limit on the number of rows returned per page, use the pageSize parameter in the first request. For example:
https://sandbox.bluesnap.com/services/2/report/TransactionDetail?period=LAST_WEEK&pageSize=5

If you do not specify a page size, the maximum size is 10,000 rows by default.

The response will include a header with the next-page-token, and will indicate the start row of the current response, as well as the total number of rows. For example:

next-page-token: bmV4dHBhZ2V0b2tlbg==
start-row: 1
total-row-count: 3019

Insert the next-page-token in the request to call the next page of results. Optionally, you can also include the format parameter. No other parameters are required. For example:

https://sandbox.bluesnap.com/services/2/report/TransactionDetail?nextPageToken=bmV4dHBhZ2V0b2tlbg==&format=csv

The last page of results will not return the next-page-token header.

Response Details

If successful, the HTTP status code is 200 OK. The report data is included in the data property. For details on any of the report parameters, see BlueSnap Reporting.

Error Handling
For information about possible errors, see Errors.

Back to Top

Examples

Request Examples

curl -v -X GET https://sandbox.bluesnap.com/services/2/report/TransactionDetail?period=CUSTOM&from_date=01%2F01%2F2016&to_date=03%2F31%2F2016&skuType=ONE_TIME&transactionType=SALE&paymentType=Credit%20Card&products=281272&contracts=2117474&pageSize=2 \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='
curl -v -X GET https://sandbox.bluesnap.com/services/2/report/TransactionDetail?nextPageToken=bmV4dHBhZ2V0b2tlbg== \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='
curl -v -X GET https://sandbox.bluesnap.com/services/2/report/AccountBalance?period=THIS_MONTH \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ='

Response Examples

next-page-token: bmV4dHBhZ2V0b2tlbg==
page-size →2
start-row →1
total-row-count →72

{
  "data": [
    {
      "Payment ID": "0",
      "Invoice ID": "1006677339",
      "Original Invoice ID": "1006677339",
      "Transaction Type": "Sale",
      "Transaction Date": "03/30/2016",
      "Purchase Date": "",
      "Refund / Chargeback Reason": "",
      "Product": "Laptop",
      "Product ID": "281272",
      "Contract": "Lenovo G550",
      "Contract ID": "2117474",
      "SKU Type": "One-time contract",
      "Payment Frequency": "Once",
      "Recurring Cycle Group": "First Time",
      "Recurring Cycle Number": "1",
      "Payment Type": "Credit Card",
      "Card Network": "Visa",
      "Qty": "1",
      "Auth. Currency": "USD",
      "Merchant Sales (Auth Currency)": "22.00",
      "Merchant Sales (Base Currency)": "22.00",
      "Shopper ID": "20081653",
      "Shopper First Name": "Shopper  first name",
      "Shopper Last Name": "Shopper last name",
      "Shopper Email": "john.smith@gmail.com",
      "Shopper Country": "United States",
      "Custom Field 1": "",
      "Custom Field 2": "",
      "Custom Field 3": "N",
      "Custom Field 4": "",
      "Custom Field 5": "",
      "Custom Field 6": "",
      "Custom Field 7": "",
      "Custom Field 8": "",
      "Custom Field 9": "",
      "Custom Field 10": ""
    },
    {
      "Payment ID": "0",
      "Invoice ID": "1006677341",
      "Original Invoice ID": "1006677341",
      "Transaction Type": "Sale",
      "Transaction Date": "03/30/2016",
      "Purchase Date": "",
      "Refund / Chargeback Reason": "",
      "Product": "Laptop",
      "Product ID": "281272",
      "Contract": "Lenovo G550",
      "Contract ID": "2117474",
      "SKU Type": "One-time contract",
      "Payment Frequency": "Once",
      "Recurring Cycle Group": "First Time",
      "Recurring Cycle Number": "1",
      "Payment Type": "Credit Card",
      "Card Network": "Visa",
      "Qty": "1",
      "Auth. Currency": "EUR",
      "Merchant Sales (Auth Currency)": "72.71",
      "Merchant Sales (Base Currency)": "99.99",
      "Shopper ID": "20081655",
      "Shopper First Name": "Vitaly",
      "Shopper Last Name": "Fligel",
      "Shopper Email": "test@test.com",
      "Shopper Country": "United States",
      "Custom Field 1": "",
      "Custom Field 2": "",
      "Custom Field 3": "N",
      "Custom Field 4": "",
      "Custom Field 5": "",
      "Custom Field 6": "",
      "Custom Field 7": "",
      "Custom Field 8": "",
      "Custom Field 9": "",
      "Custom Field 10": ""
    }
  ],
  "title": "Transaction Detail",
  "params": [
    {
      "name": "Period",
      "value": "CUSTOM"
    },
    {
      "name": "From date",
      "value": "01/01/2016"
    },
    {
      "name": "To date",
      "value": "03/31/2016"
    },
    {
      "name": "SKU Type",
      "value": "ONE_TIME"
    },
    {
      "name": "Transaction Type",
      "value": "SALE"
    },
    {
      "name": "Payment type",
      "value": "Credit Card"
    },
    {
      "name": "Products",
      "value": "281272"
    },
    {
      "name": "Contracts",
      "value": "2117474"
    },
    {
      "name": "Merchant Id",
      "value": "382526"
    }
  ],
  "date_range": "01/01/2016 - 03/31/2016",
  "base-currency": "USD"
}
{
"data":[
{"Payment ID":"0","Invoice ID":"1006650575","Original Invoice ID":"1006650575","Transaction Type":"Sale","Transaction Date":"03/17/2016","Purchase Date":"","Refund / Chargeback Reason":"","Product":"Laptop","Product ID":"281272","Contract":"Lenovo G550","Contract ID":"2117474","SKU Type":"One-time contract","Payment Frequency":"Once","Recurring Cycle Group":"First Time","Recurring Cycle Number":"1","Payment Type":"Credit Card","Card Network":"Visa","Qty":"1","Auth. Currency":"USD","Merchant Sales (Auth Currency)":"99.99","Merchant Sales (USD)":"99.99","Shopper ID":"20059723","Shopper First Name":"Shopper first name","Shopper Last Name":"Shopper last name","Shopper Email":"john.smith@gmail.com","Shopper Country":"United States","Custom Field 1":"","Custom Field 2":"","Custom Field 3":"N","Custom Field 4":"","Custom Field 5":"","Custom Field 6":"","Custom Field 7":"","Custom Field 8":"","Custom Field 9":"","Custom Field 10":""},
{"Payment ID":"0","Invoice ID":"1006650577","Original Invoice ID":"1006650575","Transaction Type":"Refund","Transaction Date":"03/17/2016","Purchase Date":"03/17/2016","Refund / Chargeback Reason":"test","Product":"Laptop","Product ID":"281272","Contract":"Lenovo G550","Contract ID":"2117474","SKU Type":"One-time contract","Payment Frequency":"Once","Recurring Cycle Group":"One Time","Payment Type":"Credit Card","Card Network":"Visa","Qty":"-1","Auth. Currency":"USD","Merchant Sales (Auth Currency)":"-99.99","Merchant Sales (USD)":"-99.99","Shopper ID":"20059723","Shopper First Name":"Shopper first name","Shopper Last Name":"Shopper last name","Shopper Email":"john.smith@gmail.com","Shopper Country":"United States","Custom Field 1":"","Custom Field 2":"","Custom Field 3":"N","Custom Field 4":"","Custom Field 5":"","Custom Field 6":"","Custom Field 7":"","Custom Field 8":"","Custom Field 9":"","Custom Field 10":""}
],
"title":"Transaction Detail",
"params":[
{"name":"Period","value":"LAST_WEEK"},{"name":"Currency","value":""},{"name":"SKU Type","value":""},{"name":"Transaction Type","value":""},{"name":"Payment type","value":""},{"name":"Payment ID","value":""},{"name":"Products","value":""},{"name":"Merchant Id","value":"391328"}
],
"date_range":"01/01/2016 - 03/31/2016"
}
{
  "data": [
    {
      "Currency": "USD",
      "Total of Gross Amount": "57,622.63",
      "Total of Commission Amount": "-1,864.41",
      "Affiliates Amount": "0.00",
      "Total of Net Amount": "55,758.22",
      "Total of Paid by 3rd Party": "-13,227.74",
      "Total of Payout Adjustment Amount": "0.00",
      "Account Balance": "42,530.48"
    }
  ],
  "title": "Account Balance",
  "params": [
    {
      "name": "Period",
      "value": "THIS_MONTH"
    },
    {
      "name": "Merchant Id",
      "value": "391328"
    }
  ],
  "date_range": "01/01/2017 - 01/24/2017"
}