{
  "opencollection": "1.0.0",
  "info": {
    "name": "Suger API Report API",
    "version": "1.0"
  },
  "items": [
    {
      "info": {
        "name": "Report",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Daily Revenue Records",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.suger.cloud/org/:orgId/dailyRevenueRecord",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Organization ID"
              },
              {
                "name": "partner",
                "value": "",
                "type": "query",
                "description": "Cloud Partner"
              },
              {
                "name": "productId",
                "value": "",
                "type": "query",
                "description": "Filter daily revenue records by the given product ID"
              },
              {
                "name": "buyerId",
                "value": "",
                "type": "query",
                "description": "Filter daily revenue records by the given buyer ID"
              },
              {
                "name": "entitlementId",
                "value": "",
                "type": "query",
                "description": "Filter daily revenue records by the given entitlement ID"
              },
              {
                "name": "startDate",
                "value": "",
                "type": "query",
                "description": "start date (UTC) in YYYY-MM-DD format, default is 30 days before the endDate"
              },
              {
                "name": "endDate",
                "value": "",
                "type": "query",
                "description": "end date (UTC) in YYYY-MM-DD format, default is today"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "list daily revenue records for the given organization, partner, entitlement, or buyer, within the given date range."
        },
        {
          "info": {
            "name": "List Revenue Records",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.suger.cloud/org/:orgId/partner/:partner/revenueRecord",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Organization ID"
              },
              {
                "name": "partner",
                "value": "",
                "type": "path",
                "description": "Cloud Partner"
              },
              {
                "name": "productId",
                "value": "",
                "type": "query",
                "description": "Filter revenue records by the given product ID"
              },
              {
                "name": "entitlementId",
                "value": "",
                "type": "query",
                "description": "Filter revenue records by the given entitlement ID"
              },
              {
                "name": "buyerId",
                "value": "",
                "type": "query",
                "description": "Filter revenue records by the given buyer ID"
              },
              {
                "name": "startDate",
                "value": "",
                "type": "query",
                "description": "start date (UTC) in YYYY-MM-DD format, default is 30 days before the endDate"
              },
              {
                "name": "endDate",
                "value": "",
                "type": "query",
                "description": "end date (UTC) in YYYY-MM-DD format, default is today"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "List pagination size, default 1000, max value is 1000"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "List pagination offset, default 0"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "list the revenue records for the given organization, product, entitlement, or buyer."
        },
        {
          "info": {
            "name": "List Revenue Record Details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.suger.cloud/org/:orgId/partner/:partner/revenueRecordDetail",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Organization ID"
              },
              {
                "name": "partner",
                "value": "",
                "type": "path",
                "description": "Cloud Partner"
              },
              {
                "name": "productId",
                "value": "",
                "type": "query",
                "description": "Filter revenue record details by the given product ID"
              },
              {
                "name": "buyerId",
                "value": "",
                "type": "query",
                "description": "Filter revenue record details by the given buyer ID"
              },
              {
                "name": "entitlementId",
                "value": "",
                "type": "query",
                "description": "Filter revenue record details by the given entitlement ID"
              },
              {
                "name": "startDate",
                "value": "",
                "type": "query",
                "description": "start date (UTC) in YYYY-MM-DD format, default is 30 days before the endDate"
              },
              {
                "name": "endDate",
                "value": "",
                "type": "query",
                "description": "end date (UTC) in YYYY-MM-DD format, default is today"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "List pagination size, default 1000, max value is 1000"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "List pagination offset, default 0"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "list the raw revenue record details for the given organization, partner, product, entitlement, or buyer."
        },
        {
          "info": {
            "name": "List Usage Metering Daily Records",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.suger.cloud/org/:orgId/partner/:partner/usageMeteringDailyRecord",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Organization ID"
              },
              {
                "name": "partner",
                "value": "",
                "type": "path",
                "description": "Filter by the Cloud Partner"
              },
              {
                "name": "buyerId",
                "value": "",
                "type": "query",
                "description": "Filter usage metering daily records by the given buyer ID"
              },
              {
                "name": "entitlementId",
                "value": "",
                "type": "query",
                "description": "Filter usage metering daily records by the given entitlement ID"
              },
              {
                "name": "startDate",
                "value": "",
                "type": "query",
                "description": "start date (UTC) in YYYY-MM-DD format, default is 30 days before the endDate"
              },
              {
                "name": "endDate",
                "value": "",
                "type": "query",
                "description": "end date (UTC) in YYYY-MM-DD format, default is today"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "List pagination size, default 1000, max value is 1000"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "List pagination offset, default 0"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "list the daily records of the usage metering from the cloud marketplace for the given organization, entitlement, or buyer."
        },
        {
          "info": {
            "name": "Get Revenue Report",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.suger.cloud/org/:orgId/revenueReport",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Organization ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Get the revenue report of the given organization, product, entitlement, or buyer."
        }
      ]
    }
  ],
  "bundled": true
}