{
  "opencollection": "1.0.0",
  "info": {
    "name": "GetResponse APIv3 Custom Reports",
    "version": "3.2026-07-28T07:58:55+00:00"
  },
  "items": [
    {
      "info": {
        "name": "Custom Reports",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get a single custom report by ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.getresponse.com/v3/custom-reports/:customReportId",
            "params": [
              {
                "name": "customReportId",
                "value": "cRi",
                "type": "path",
                "description": "The custom report ID"
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "The endpoint allows retrieving detailed information about a custom report based on the provided `customReportId`. It returns report data, including:\n * details about the report,\n * generation statuses of the report files,\n * URLs from which the report files can be downloaded.\n\nMore information on using custom reports can be found in the Case Study section of the [API documentation](http://apidocs.getresponse.com/v3/case-study/custom-reports)."
        },
        {
          "info": {
            "name": "Get a list of custom reports",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.getresponse.com/v3/custom-reports",
            "params": [
              {
                "name": "query[name]",
                "value": "",
                "type": "query",
                "description": "Search custom reports by name"
              },
              {
                "name": "sort[name]",
                "value": "",
                "type": "query",
                "description": "Sort custom reports by name"
              },
              {
                "name": "sort[frequency]",
                "value": "",
                "type": "query",
                "description": "Sort custom reports by frequency"
              },
              {
                "name": "sort[generatedAt]",
                "value": "",
                "type": "query",
                "description": "Sort custom reports by generation date"
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "List of fields that should be returned. Id is always returned. Fields should be separated by comma"
              },
              {
                "name": "perPage",
                "value": "",
                "type": "query",
                "description": "Requested number of results per page"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page number"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "You can filter the resource using criteria specified as `query[*]`. You can provide multiple criteria, to use AND logic. You can sort the resource using parameters specified as `sort[*]`. You can specify multiple fields to sort by."
        },
        {
          "info": {
            "name": "Create the custom report",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.getresponse.com/v3/custom-reports",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "X-Auth-Token",
              "value": "{{X-Auth-Token}}",
              "placement": "header"
            }
          },
          "docs": "The endpoint allows scheduling a custom report of a specific type for a given time period. Depending on the report type, you can also narrow down the data using appropriate filters.\n\n<strong>Important:</strong> The reports you can generate depend on your pricing plan.\n\nMore information about using the endpoint, along with examples, can be found in the Case Study section of the [API documentation](http://apidocs.getresponse.com/v3/case-study/custom-reports-scheduling)."
        }
      ]
    }
  ],
  "bundled": true
}