{
  "opencollection": "1.0.0",
  "info": {
    "name": "Vantage AccessGrants BusinessMetrics API",
    "version": "2.0.0"
  },
  "request": {
    "auth": {
      "type": "oauth2",
      "flow": "client_credentials",
      "accessTokenUrl": "https://console.vantage.sh/account/profile",
      "credentials": {
        "clientId": "{{clientId}}",
        "clientSecret": "{{clientSecret}}"
      }
    }
  },
  "items": [
    {
      "info": {
        "name": "BusinessMetrics",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get all business metrics",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.vantage.sh/v2/business_metrics",
            "params": [
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The page of results to return."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The amount of results to return. The maximum is 1000."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://console.vantage.sh/account/profile",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Return all BusinessMetrics that the current API token has access to."
        },
        {
          "info": {
            "name": "Create business metric",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.vantage.sh/v2/business_metrics",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://console.vantage.sh/account/profile",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Create a new BusinessMetric."
        },
        {
          "info": {
            "name": "Get business metric by token",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.vantage.sh/v2/business_metrics/:business_metric_token",
            "params": [
              {
                "name": "business_metric_token",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://console.vantage.sh/account/profile",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Return a BusinessMetric."
        },
        {
          "info": {
            "name": "Update business metric",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.vantage.sh/v2/business_metrics/:business_metric_token",
            "params": [
              {
                "name": "business_metric_token",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://console.vantage.sh/account/profile",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Updates an existing BusinessMetric."
        },
        {
          "info": {
            "name": "Delete business metric",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.vantage.sh/v2/business_metrics/:business_metric_token",
            "params": [
              {
                "name": "business_metric_token",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://console.vantage.sh/account/profile",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Deletes an existing BusinessMetric."
        },
        {
          "info": {
            "name": "Get business metric values",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.vantage.sh/v2/business_metrics/:business_metric_token/values",
            "params": [
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The page of results to return."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The amount of results to return. The maximum is 1000."
              },
              {
                "name": "start_date",
                "value": "",
                "type": "query",
                "description": "Query BusinessMetrics by the first date you would like to filter from. ISO 8601 Formatted - 2021-07-15"
              },
              {
                "name": "business_metric_token",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://console.vantage.sh/account/profile",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Return values of a BusinessMetric"
        },
        {
          "info": {
            "name": "Delete business metric values",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.vantage.sh/v2/business_metrics/:business_metric_token/values",
            "params": [
              {
                "name": "start_date",
                "value": "",
                "type": "query",
                "description": "Inclusive lower bound (ISO 8601 date or datetime, UTC). Date-only values start at 00:00:00 UTC that day."
              },
              {
                "name": "end_date",
                "value": "",
                "type": "query",
                "description": "Inclusive upper bound (ISO 8601 date or datetime, UTC). Date-only values include the full calendar day through 23:59:59.999999999 UTC."
              },
              {
                "name": "label",
                "value": "",
                "type": "query",
                "description": "When present in the query string (including as an empty value), only unit metrics with this exact label are deleted. Omit the parameter to delete all labels in range."
              },
              {
                "name": "forecasted",
                "value": "",
                "type": "query",
                "description": "When true, deletes forecasted unit metrics instead of historical ones."
              },
              {
                "name": "business_metric_token",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://console.vantage.sh/account/profile",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Deletes Business Metric values (historical or forecasted unit metrics)."
        },
        {
          "info": {
            "name": "Get business metric forecasted values",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.vantage.sh/v2/business_metrics/:business_metric_token/forecasted_values",
            "params": [
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The page of results to return."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The amount of results to return. The maximum is 1000."
              },
              {
                "name": "start_date",
                "value": "",
                "type": "query",
                "description": "Query BusinessMetrics by the first date you would like to filter from. ISO 8601 Formatted - 2021-07-15"
              },
              {
                "name": "business_metric_token",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://console.vantage.sh/account/profile",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Return forecasted values of a BusinessMetric"
        },
        {
          "info": {
            "name": "Update business metric values from CSV",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.vantage.sh/v2/business_metrics/:business_metric_token/values.csv",
            "params": [
              {
                "name": "business_metric_token",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "form-urlencoded",
              "data": [
                {
                  "name": "csv",
                  "value": ""
                },
                {
                  "name": "forecasted",
                  "value": ""
                }
              ]
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://console.vantage.sh/account/profile",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Updates the values for an existing BusinessMetric from a CSV file."
        }
      ]
    }
  ],
  "bundled": true
}