{
  "opencollection": "1.0.0",
  "info": {
    "name": "VTex Anti-fraud Provider Account Reports API",
    "version": "1.0"
  },
  "items": [
    {
      "info": {
        "name": "Reports",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "VTex List report templates",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{providerApiEndpoint}/api/rns/pvt/reports",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ]
          },
          "docs": "List all report templates available."
        },
        {
          "info": {
            "name": "VTex Get report document details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{providerApiEndpoint}/api/rns/pvt/reports/:reportName/documents/:documentId",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "reportName",
                "value": "",
                "type": "path",
                "description": "Name of the report"
              },
              {
                "name": "documentId",
                "value": "",
                "type": "path",
                "description": "Id from the desired report document"
              }
            ]
          },
          "docs": "Retrieve a specific report document by its Id."
        },
        {
          "info": {
            "name": "VTex Generate report",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{providerApiEndpoint}/api/rns/pvt/reports/:reportName/documents",
            "headers": [
              {
                "name": "Content-Type",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "reportName",
                "value": "",
                "type": "path",
                "description": "Name of the type of report in wish to generate. The following values are accepted: \n\n - `subscriptionsWithStatus` \n\n - `subscriptionsScheduledBetweenDate` \n\n - `subscriptionsUpdatedBetweenDate` \n\n - `subscriptionsCreatedBetweenDate` \n\n - `executionsBetweenDate`"
              },
              {
                "name": "email",
                "value": "",
                "type": "query",
                "description": "The report is sent to the email in this field."
              },
              {
                "name": "beginDate",
                "value": "",
                "type": "query",
                "description": "Start date of the report with the format `yyyy-mm-dd`. This field is required for any type of report."
              },
              {
                "name": "endDate",
                "value": "",
                "type": "query",
                "description": "End date of the report with the format `yyyy-mm-dd`. This field is required for any type of report."
              }
            ]
          },
          "docs": "This endpoint creates a new report in the format of a CSV file and sends it via email. You can generate one of the following reports: \n\n - subscriptionsWithStatus \n\n - subscriptionsScheduledBetweenDate \n\n - subscriptionsUpdatedBetweenDate \n\n - subscriptionsCreatedBetweenDate \n\n - executionsBetweenDate"
        }
      ]
    }
  ],
  "bundled": true
}