{
  "opencollection": "1.0.0",
  "info": {
    "name": "Puzzle Api Accounts Metrics API",
    "version": "0"
  },
  "items": [
    {
      "info": {
        "name": "Metrics",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get Expense Metrics",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://staging.southparkdata.com/rest/v0/company/:id/metrics/expenses",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The company ID"
              },
              {
                "name": "startDate",
                "value": "",
                "type": "query"
              },
              {
                "name": "endDateExclusive",
                "value": "",
                "type": "query"
              },
              {
                "name": "interval",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Retrieves a summary of a company's expenses for a given time span, broken into chunks as specified in the 'interval' param\n\nCurrently only the 'month' interval is supported, but will soon support 'quarter' and 'year'.\n\nThe array of metrics will be returned in ascending order from earliest time interval to latest.\n\nRequired scope: read:company"
        },
        {
          "info": {
            "name": "Get Categorization Metrics",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://staging.southparkdata.com/rest/v0/company/:id/metrics/categorization",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The company ID"
              },
              {
                "name": "startDate",
                "value": "",
                "type": "query"
              },
              {
                "name": "endDateExclusive",
                "value": "",
                "type": "query"
              },
              {
                "name": "interval",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Retrieves categorization metrics for the company.\n\nRequired scope: read:company"
        },
        {
          "info": {
            "name": "Get Revenue Metrics",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://staging.southparkdata.com/rest/v0/company/:id/metrics/revenue",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The company ID"
              },
              {
                "name": "startDate",
                "value": "",
                "type": "query"
              },
              {
                "name": "endDateExclusive",
                "value": "",
                "type": "query"
              },
              {
                "name": "interval",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Retrieves a summary of a company's revenue for a given time span, broken into chunks as specified in the 'interval' param. We will soon support additional revenue metrics such as ARR and accrual-based ARR.\n\nCurrently only the 'month' interval is supported, but will soon support 'quarter' and 'year'.\n\nThe array of metrics will be returned in ascending order from earliest time interval to latest.\n\nRequired scope: read:company"
        },
        {
          "info": {
            "name": "Get Employee Metrics",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://staging.southparkdata.com/rest/v0/company/:id/metrics/employee",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The company ID"
              },
              {
                "name": "startDate",
                "value": "",
                "type": "query"
              },
              {
                "name": "endDateExclusive",
                "value": "",
                "type": "query"
              },
              {
                "name": "interval",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Retrieves a summary of a company's employees for a given time span, broken into chunks as specified in the 'interval' param. The metrics are currently across all departments. We will support filtering by department in the near future.\n\nCurrently only the 'month' interval is supported, but will soon support 'quarter' and 'year'.\n\nThe array of metrics will be returned in ascending order from earliest time interval to latest.\n\nRequired scope: read:company"
        },
        {
          "info": {
            "name": "Get Spending Metrics",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://staging.southparkdata.com/rest/v0/company/:id/metrics/spending",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The company ID"
              },
              {
                "name": "startDate",
                "value": "",
                "type": "query"
              },
              {
                "name": "endDateExclusive",
                "value": "",
                "type": "query"
              },
              {
                "name": "interval",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Retrieves payroll and non-payroll spending metrics for the given period range. Provide startPeriod and endPeriod in YYYY-MM format.\n\nRequired scope: read:company"
        }
      ]
    }
  ],
  "bundled": true
}