m3ter postman collection.json
{
"info": {
"_postman_id": "c425870d-6648-49f5-bb7d-de9fa15109ec",
"name": "m3ter-Template API Collection",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"_exporter_id": "21014760"
},
"item": [
{
"name": "Config",
"item": [
{
"name": "List Products",
"event": [
{
"listen": "test",
"script": {
"exec": [
"pm.test(\"Status code is 200\", function () {\r",
" pm.response.to.have.status(200);\r",
"});"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/products?pageSize=100",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"products"
],
"query": [
{
"key": "pageSize",
"value": "100"
}
]
}
},
"response": []
},
{
"name": "List Meters",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/meters?pageSize=100",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"meters"
],
"query": [
{
"key": "pageSize",
"value": "100"
}
]
}
},
"response": []
},
{
"name": "List Aggregations",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/aggregations?pageSize=100",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"aggregations"
],
"query": [
{
"key": "pageSize",
"value": "100"
}
]
}
},
"response": []
},
{
"name": "List Compound Aggregations",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/compoundaggregations?pageSize=100",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"compoundaggregations"
],
"query": [
{
"key": "pageSize",
"value": "100"
}
]
}
},
"response": []
},
{
"name": "List PlanTemplates",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/plantemplates",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"plantemplates"
]
}
},
"response": []
},
{
"name": "List Plans",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/plans",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"plans"
]
}
},
"response": []
},
{
"name": "List Credits",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/credits?pageSize=100",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"credits"
],
"query": [
{
"key": "pageSize",
"value": "100"
}
]
}
},
"response": []
},
{
"name": "List CreditTypes",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/credittypes?pageSize=100",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"credittypes"
],
"query": [
{
"key": "pageSize",
"value": "100"
}
]
}
},
"response": []
},
{
"name": "List Pricings",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/pricings",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"pricings"
]
}
},
"response": []
},
{
"name": "List Accounts",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/accounts?pageSize=100",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"accounts"
],
"query": [
{
"key": "pageSize",
"value": "100"
}
]
}
},
"response": []
},
{
"name": "List AccountPlans",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/accountplans?pageSize=200",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"accountplans"
],
"query": [
{
"key": "pageSize",
"value": "200"
}
]
}
},
"response": []
},
{
"name": "List Plan Groups",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/plangroups?pageSize=100",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"plangroups"
],
"query": [
{
"key": "pageSize",
"value": "100"
}
]
}
},
"response": []
},
{
"name": "List Plan Group Links",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/plangrouplinks?pageSize=200",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"plangrouplinks"
],
"query": [
{
"key": "pageSize",
"value": "200"
}
]
}
},
"response": []
},
{
"name": "List AccountPlans",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/accountplans?pageSize=100",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"accountplans"
],
"query": [
{
"key": "pageSize",
"value": "100"
}
]
}
},
"response": []
},
{
"name": "List Commitments",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/commitments?pageSize=100",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"commitments"
],
"query": [
{
"key": "pageSize",
"value": "100"
}
]
}
},
"response": []
},
{
"name": "List External Mappings",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/externalmappings?pageSize=100",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"externalmappings"
],
"query": [
{
"key": "pageSize",
"value": "100"
}
]
}
},
"response": []
},
{
"name": "Delete Aggregation",
"request": {
"method": "DELETE",
"header": [],
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/aggregations/510c52f9-90a6-461d-9d7a-1d1e4c190dbb",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"aggregations",
"510c52f9-90a6-461d-9d7a-1d1e4c190dbb"
]
}
},
"response": []
},
{
"name": "Delete Meter",
"request": {
"method": "DELETE",
"header": [],
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/meters/9f2f78a1-e53f-4c64-a37c-19e4d0bb49c7",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"meters",
"9f2f78a1-e53f-4c64-a37c-19e4d0bb49c7"
]
}
},
"response": []
},
{
"name": "Delete Product",
"request": {
"method": "DELETE",
"header": [],
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/products/f77b4831-987a-4d83-bfbb-f9439c40b830",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"products",
"f77b4831-987a-4d83-bfbb-f9439c40b830"
]
}
},
"response": []
},
{
"name": "Delete Bill",
"request": {
"method": "DELETE",
"header": [],
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/bills/7cdfc446-bc5a-4da0-81f2-6e6c3f9c8c5b",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"bills",
"7cdfc446-bc5a-4da0-81f2-6e6c3f9c8c5b"
]
}
},
"response": []
},
{
"name": "Delete Pricing",
"request": {
"method": "DELETE",
"header": [],
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/pricings/7677569d-a9a8-4e03-93ec-321b0e587f06",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"pricings",
"7677569d-a9a8-4e03-93ec-321b0e587f06"
]
}
},
"response": []
},
{
"name": "Delete PlanGroupLinks",
"request": {
"method": "DELETE",
"header": [],
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/plangrouplinks/db4d0008-058e-41a8-9af6-d98a561076fe",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"plangrouplinks",
"db4d0008-058e-41a8-9af6-d98a561076fe"
]
}
},
"response": []
},
{
"name": "Delete PlanGroups",
"request": {
"method": "DELETE",
"header": [],
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/plangroups/0860944e-0a15-44d6-85e0-a37f53fb7612",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"plangroups",
"0860944e-0a15-44d6-85e0-a37f53fb7612"
]
}
},
"response": []
},
{
"name": "Delete Plans Copy",
"request": {
"method": "DELETE",
"header": [],
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/plans/314551cc-79bd-46af-b3bf-66e59d817aed",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"plans",
"314551cc-79bd-46af-b3bf-66e59d817aed"
]
}
},
"response": []
},
{
"name": "Delete AccountPlans",
"request": {
"method": "DELETE",
"header": [],
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/accountplans/0e83d365-224f-4d67-92de-9001870a644e",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"accountplans",
"0e83d365-224f-4d67-92de-9001870a644e"
]
}
},
"response": []
},
{
"name": "Delete Accounts",
"request": {
"method": "DELETE",
"header": [],
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/accounts/51b71f88-451b-46ae-b934-451e2aa8586f",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"accounts",
"51b71f88-451b-46ae-b934-451e2aa8586f"
]
}
},
"response": []
},
{
"name": "Delete Commitments",
"request": {
"method": "DELETE",
"header": [],
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/commitments/75c3b1d3-ef46-4d49-8990-3b3679b50ec5",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"commitments",
"75c3b1d3-ef46-4d49-8990-3b3679b50ec5"
]
}
},
"response": []
},
{
"name": "Delete PlanTemplates",
"request": {
"method": "DELETE",
"header": [],
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/plantemplates/314551cc-79bd-46af-b3bf-66e59d817aed",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"plantemplates",
"314551cc-79bd-46af-b3bf-66e59d817aed"
]
}
},
"response": []
},
{
"name": "Create Product",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"\",\n \"code\": \"\"\n}"
},
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/products",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"products"
]
}
},
"response": []
},
{
"name": "Create Meter",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\"productId\": \"\",\n\t\"name\": \"\",\n\t\"code\": \"\",\n\t\"dataFields\": [\n {\n\t\t\"category\": \"\",\n\t\t\"code\": \"\",\n\t\t\"name\": \"\"\n\t },\n {\n\t\t\"category\": \"\",\n\t\t\"code\": \"\",\n\t\t\"name\": \"\"\n\t },\n {\n\t\t\"category\": \"\",\n\t\t\"code\": \"\",\n\t\t\"name\": \"\"\n\t },\n {\n\t\t\"category\": \"\",\n\t\t\"code\": \"\",\n\t\t\"unit\": \"\",\n\t\t\"name\": \"\"\n\t }\n ],\n\t\"derivedFields\": []\n}"
},
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/meters",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"meters"
]
}
},
"response": []
},
{
"name": "Create Aggregation",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"version\": 0,\n \"name\": \"string\",\n \"rounding\": \"UP\",\n \"quantityPerUnit\": 0,\n \"unit\": \"string\",\n \"code\": \"string\",\n \"meterId\": \"\",\n \"targetField\": \"string\",\n \"aggregation\": \"SUM\",\n \"segmentedFields\": [\n \"string\"\n ],\n \"segments\": [\n {}\n ],\n\"defaultValue\": 0\n}"
},
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/aggregations",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"aggregations"
]
}
},
"response": []
},
{
"name": "Create CompoundAggregation",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"id\": \"string\",\n \"version\": 0,\n \"name\": \"string\",\n \"rounding\": \"UP\",\n \"quantityPerUnit\": 0,\n \"unit\": \"string\",\n \"code\": \"string\",\n \"meterId\": \"\",\n \"targetField\": \"string\",\n \"aggregation\": \"SUM\",\n \"segmentedFields\": [\n \"string\"\n ],\n \"segments\": [\n {\n \"property1\": \"string\",\n \"property2\": \"string\"\n }\n ],\n \"defaultValue\": 0\n}"
},
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/aggregations",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"aggregations"
]
}
},
"response": []
},
{
"name": "Create PlanTemplate",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"version\": 0,\n \"customFields\": { },\n \"productId\": \"\",\n \"name\": \"string\",\n \"currency\": \"str\",\n \"standingCharge\": 0,\n \"standingChargeInterval\": 1,\n \"standingChargeOffset\": 364,\n \"billFrequencyInterval\": 1,\n \"billFrequency\": \"DAILY\",\n \"ordinal\": 0,\n \"code\": \"string\",\n \"minimumSpend\": 0,\n \"standingChargeBillInAdvance\": true,\n \"minimumSpendBillInAdvance\": true\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/plantemplates",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"plantemplates"
]
}
},
"response": []
},
{
"name": "Create Plan",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"version\": 0,\n \"customFields\": { },\n \"planTemplateId\": \"\",\n \"name\": \"string\",\n \"code\": \"string\",\n \"standingCharge\": 0,\n \"ordinal\": 0,\n \"bespoke\": true,\n \"minimumSpend\": 0,\n \"standingChargeBillInAdvance\": true,\n \"minimumSpendBillInAdvance\": true\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/plans",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"plans"
]
}
},
"response": []
},
{
"name": "Create Pricing",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"planId\": \"\",\n \"compoundAggregationId\": \"\",\n \"startDate\": \"\",\n \"cumulative\": true,\n \"pricingBands\": [\n {\"lowerLimit\": 0, \"fixedPrice\": 0, \"unitPrice\": 0}\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/pricings",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"pricings"
]
}
},
"response": []
},
{
"name": "Create Account",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"\",\n \"code\": \"\",\n \"address\": {\"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"addressLine3\":null,\n \"addressLine4\":null,\n \"locality\": \"\",\n \"region\": \"\",\n \"postCode\": \"\",\n \"country\": \"\"},\n \"emailAddress\": \"\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/accounts",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"accounts"
]
}
},
"response": []
},
{
"name": "Create Commitment",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"accountId\": \"\",\n \"billingPlanId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"amount\": 0,\n \"currency\": \"\",\n \"amountFirstBill\": 0,\n \"overageSurchargePercent\": 0,\n \"billingInterval\": 1,\n \"billingOffset\": 0,\n \"commitmentFeeDescription\": \"\",\n \"commitmentUsageDescription\": \"\",\n \"overageDescription\": \"\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/commitments",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"commitments"
]
}
},
"response": []
},
{
"name": "Create AccountPlan",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n\"version\": 0,\n\"customFields\": { },\n\"accountId\": \"\",\n\"planId\": \"\",\n\"planGroupId\": \"\",\n\"startDate\": \"2019-08-24T14:15:22Z\",\n\"endDate\": \"2019-08-24T14:15:22Z\",\n\"code\": \"string\",\n\"billEpoch\": \"2019-08-24\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/accountplans",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"accountplans"
]
}
},
"response": []
},
{
"name": "Update Account",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"\",\n \"code\": \"\",\n \"version\": 1,\n \"address\": {\"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"addressLine3\":null,\n \"addressLine4\":null,\n \"locality\": \"\",\n \"region\": \"\",\n \"postCode\": \"\",\n \"country\": \"\"},\n \"emailAddress\": \"\",\n \"configData\": { },\n \"parentAccountId\": \"\",\n \"billEpoch\": \"2019-08-24\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/accounts/ac5fcd56-3800-4f84-98dd-feaf1f6ebadd",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"accounts",
"ac5fcd56-3800-4f84-98dd-feaf1f6ebadd"
]
}
},
"response": []
},
{
"name": "Update AccountPlan",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"id\": \"\",\n \"version\": 2,\n \"accountId\": \"\",\n \"productId\": \"\",\n \"planId\": \"\",\n \"startDate\": \"\",\n \"endDate\": \"\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/accountplans/5f115337-47d0-4a9e-9465-deb40abbcd0c",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"accountplans",
"5f115337-47d0-4a9e-9465-deb40abbcd0c"
]
}
},
"response": []
},
{
"name": "Update Meter",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"version\": 0,\n \"customFields\": {},\n \"productId\": \"\",\n \"groupId\": \"\",\n \"name\": \"\",\n \"code\": \"\",\n \"dataFields\": [\n {\n \"category\": \"WHO\",\n \"code\": \"\",\n \"name\": \"\",\n \"unit\": \"\"\n }\n ],\n \"derivedFields\": [\n {\n \"category\": \"WHO\",\n \"code\": \"\",\n \"name\": \"\",\n \"unit\": \"\",\n \"calculation\": \"\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/meters/88c4d796-9106-413c-b099-dc595e1a0625",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"meters",
"88c4d796-9106-413c-b099-dc595e1a0625"
]
}
},
"response": []
},
{
"name": "Update Commitment",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"version\": 0,\n \"accountId\": \"string\",\n \"billingPlanId\": \"string\",\n \"productIds\": [\n \"string\"\n ],\n \"startDate\": \"2022-05-18\",\n \"endDate\": \"2023-05-18\",\n \"currency\": \"string\",\n \"amount\": 0,\n \"amountPrePaid\": 0,\n \"amountFirstBill\": 0,\n \"overageSurchargePercent\": 0,\n \"billingInterval\": 1,\n \"billingOffset\": 364,\n \"commitmentFeeDescription\": \"string\",\n \"commitmentUsageDescription\": \"string\",\n \"overageDescription\": \"string\",\n \"commitmentFeeBillInAdvance\": true,\n \"billEpoch\": \"2022-05-18\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/commitments/COMMITMENT_UUID",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"commitments",
"COMMITMENT_UUID"
]
}
},
"response": []
},
{
"name": "Update Pricing",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"version\": 0,\n \"planId\": \"string\",\n \"planTemplateId\": \"string\",\n \"aggregationId\": \"string\",\n \"compoundAggregationId\": \"string\",\n \"segment\": {\n \"property1\": \"string\",\n \"property2\": \"string\"\n },\n \"cumulative\": true,\n \"tiersSpanPlan\": true,\n \"pricingBands\": [\n {\n \"id\": \"string\",\n \"lowerLimit\": 0,\n \"fixedPrice\": 0,\n \"unitPrice\": 0,\n \"creditTypeId\": \"string\"\n }\n ],\n \"startDate\": \"2019-08-24T14:15:22Z\",\n \"endDate\": \"2019-08-24T14:15:22Z\",\n \"minimumSpend\": 0,\n \"description\": \"string\",\n \"type\": \"DEBIT\",\n \"code\": \"string\",\n \"minimumSpendBillInAdvance\": true\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/pricings/PRICING_UUID",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"pricings",
"PRICING_UUID"
]
}
},
"response": []
},
{
"name": "Update Aggregation",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"id\": \"\",\n \"version\": 1,\n \"name\": \"\",\n \"rounding\": \"\",\n \"quantityPerUnit\": 1,\n \"unit\": \"\",\n \"code\": \"\",\n \"meterId\": \"\",\n \"targetField\": \"\",\n \"aggregation\": \"\",\n \"segmentedFields\": [],\n \"segments\": []\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/aggregations/2372b42c-64bc-4bee-8fc6-72358ae4e295",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"aggregations",
"2372b42c-64bc-4bee-8fc6-72358ae4e295"
]
}
},
"response": []
},
{
"name": "Update Plan",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"planTemplateId\": \"\",\n \"productId\": \"\",\n \"name\": \"\",\n \"code\": \"\",\n \"minimumSpend\": 0,\n \"bespoke\": false\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/plans/b6f198a1-74ff-4670-a8d2-8e02c6641cef",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"plans",
"b6f198a1-74ff-4670-a8d2-8e02c6641cef"
]
}
},
"response": []
},
{
"name": "Update Plan Group",
"request": {
"method": "PUT",
"header": [
{
"key": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"\",\n \"code\": \"\",\n \"standingCharge\": 0,\n \"minimumSpend\": 0.0,\n \"version\": 1,\n \"currency\": \"USD\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/plangroups/abc361bb-2d77-4c74-be2d-259fc4e18f41",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"plangroups",
"abc361bb-2d77-4c74-be2d-259fc4e18f41"
]
}
},
"response": []
},
{
"name": "Get Aggregation",
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\"name\": \"\",\n \"meterId\": \"\",\n \"version\": 1,\n\t\"targetField\": \"\",\n\t\"aggregation\": \"\",\n\t\"rounding\": \"\",\n\t\"quantityPerUnit\": 1,\n\t\"unit\": \"\",\n\t\"segmentedFields\": [\"check_type\", \"check_location\"],\n\t\"segments\": [{\n\t\t\t\"check_type\": \"value1\",\n\t\t\t\"check_location\": \"value2\"\n\t\t},\n\t\t{\n\t\t\t\"check_type\": \"value1\",\n\t\t\t\"check_location\": \"value3\"\n\t\t}\n\t]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/aggregations/d7510c1a-8ab0-4633-a69f-d62e12ce7222",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"aggregations",
"d7510c1a-8ab0-4633-a69f-d62e12ce7222"
]
}
},
"response": []
},
{
"name": "Get Plan Group Links",
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\"name\": \"Billable Checks Aggregation\",\n \"meterId\": \"81fcbbe1-8322-4d32-a5df-d3e76c1e749f\",\n \"version\": 1,\n\t\"targetField\": \"check_type\",\n\t\"aggregation\": \"COUNT\",\n\t\"rounding\": \"DOWN\",\n\t\"quantityPerUnit\": 1,\n\t\"unit\": \"{transactions}\",\n\t\"segmentedFields\": [\"check_type\", \"check_location\"],\n\t\"segments\": [{\n\t\t\t\"check_type\": \"value1\",\n\t\t\t\"check_location\": \"value2\"\n\t\t},\n\t\t{\n\t\t\t\"check_type\": \"value1\",\n\t\t\t\"check_location\": \"value3\"\n\t\t}\n\t]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/plangrouplinks/1a45b04b-bc89-4fc6-a275-f08f77e2ad11",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"plangrouplinks",
"1a45b04b-bc89-4fc6-a275-f08f77e2ad11"
]
}
},
"response": []
},
{
"name": "Get Plan Groups",
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\"name\": \"Billable Checks Aggregation\",\n \"meterId\": \"81fcbbe1-8322-4d32-a5df-d3e76c1e749f\",\n \"version\": 1,\n\t\"targetField\": \"check_type\",\n\t\"aggregation\": \"COUNT\",\n\t\"rounding\": \"DOWN\",\n\t\"quantityPerUnit\": 1,\n\t\"unit\": \"{transactions}\",\n\t\"segmentedFields\": [\"check_type\", \"check_location\"],\n\t\"segments\": [{\n\t\t\t\"check_type\": \"value1\",\n\t\t\t\"check_location\": \"value2\"\n\t\t},\n\t\t{\n\t\t\t\"check_type\": \"value1\",\n\t\t\t\"check_location\": \"value3\"\n\t\t}\n\t]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/plangroups/6d3cee37-de22-4901-b43c-c2fa0cdfd4ca",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"plangroups",
"6d3cee37-de22-4901-b43c-c2fa0cdfd4ca"
]
}
},
"response": []
},
{
"name": "Get Plan",
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\"name\": \"Billable Checks Aggregation\",\n \"meterId\": \"81fcbbe1-8322-4d32-a5df-d3e76c1e749f\",\n \"version\": 1,\n\t\"targetField\": \"check_type\",\n\t\"aggregation\": \"COUNT\",\n\t\"rounding\": \"DOWN\",\n\t\"quantityPerUnit\": 1,\n\t\"unit\": \"{transactions}\",\n\t\"segmentedFields\": [\"check_type\", \"check_location\"],\n\t\"segments\": [{\n\t\t\t\"check_type\": \"value1\",\n\t\t\t\"check_location\": \"value2\"\n\t\t},\n\t\t{\n\t\t\t\"check_type\": \"value1\",\n\t\t\t\"check_location\": \"value3\"\n\t\t}\n\t]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/plans/78115760-c13b-43d2-8f21-b3a1573d73f3",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"plans",
"78115760-c13b-43d2-8f21-b3a1573d73f3"
]
}
},
"response": []
},
{
"name": "Get Account",
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\"name\": \"Billable Checks Aggregation\",\n \"meterId\": \"81fcbbe1-8322-4d32-a5df-d3e76c1e749f\",\n \"version\": 1,\n\t\"targetField\": \"check_type\",\n\t\"aggregation\": \"COUNT\",\n\t\"rounding\": \"DOWN\",\n\t\"quantityPerUnit\": 1,\n\t\"unit\": \"{transactions}\",\n\t\"segmentedFields\": [\"check_type\", \"check_location\"],\n\t\"segments\": [{\n\t\t\t\"check_type\": \"value1\",\n\t\t\t\"check_location\": \"value2\"\n\t\t},\n\t\t{\n\t\t\t\"check_type\": \"value1\",\n\t\t\t\"check_location\": \"value3\"\n\t\t}\n\t]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/accounts/7a553828-2adb-45dc-a4fe-a3213a287506",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"accounts",
"7a553828-2adb-45dc-a4fe-a3213a287506"
]
}
},
"response": []
},
{
"name": "Get AccountPlan",
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\"name\": \"Billable Checks Aggregation\",\n \"meterId\": \"81fcbbe1-8322-4d32-a5df-d3e76c1e749f\",\n \"version\": 1,\n\t\"targetField\": \"check_type\",\n\t\"aggregation\": \"COUNT\",\n\t\"rounding\": \"DOWN\",\n\t\"quantityPerUnit\": 1,\n\t\"unit\": \"{transactions}\",\n\t\"segmentedFields\": [\"check_type\", \"check_location\"],\n\t\"segments\": [{\n\t\t\t\"check_type\": \"value1\",\n\t\t\t\"check_location\": \"value2\"\n\t\t},\n\t\t{\n\t\t\t\"check_type\": \"value1\",\n\t\t\t\"check_location\": \"value3\"\n\t\t}\n\t]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/accountplans/c83b54af-1de7-4b1e-bd79-dfbf8a71ff00",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"accountplans",
"c83b54af-1de7-4b1e-bd79-dfbf8a71ff00"
]
}
},
"response": []
},
{
"name": "Get Product",
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\"name\": \"Billable Checks Aggregation\",\n \"meterId\": \"81fcbbe1-8322-4d32-a5df-d3e76c1e749f\",\n \"version\": 1,\n\t\"targetField\": \"check_type\",\n\t\"aggregation\": \"COUNT\",\n\t\"rounding\": \"DOWN\",\n\t\"quantityPerUnit\": 1,\n\t\"unit\": \"{transactions}\",\n\t\"segmentedFields\": [\"check_type\", \"check_location\"],\n\t\"segments\": [{\n\t\t\t\"check_type\": \"value1\",\n\t\t\t\"check_location\": \"value2\"\n\t\t},\n\t\t{\n\t\t\t\"check_type\": \"value1\",\n\t\t\t\"check_location\": \"value3\"\n\t\t}\n\t]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/products/39b14401-dba9-4ac6-9ba2-5a1b76f76617",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"products",
"39b14401-dba9-4ac6-9ba2-5a1b76f76617"
]
}
},
"response": []
}
],
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"exec": [
""
]
}
}
]
},
{
"name": "Usage Data",
"item": [
{
"name": "Send Usage",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\"measurements\": [{\n\t\t\"meter\": \"\",\n\t\t\"account\": \"\",\n\t\t\"ts\": \"\",\n\t\t\"measure\": {\n\t\t\t\"event\": 0\n\t\t},\n\t\t\"uid\": \"\"\n\t}]\n}"
},
"url": {
"raw": "https://ingest.m3ter.com/organizations/{{org_id}}/measurements",
"protocol": "https",
"host": [
"ingest",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"measurements"
]
}
},
"response": []
},
{
"name": "List Usage",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/measurements/6a2c2182-3769-4d43-a4ef-b9cb77669160",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"measurements",
"6a2c2182-3769-4d43-a4ef-b9cb77669160"
]
}
},
"response": []
},
{
"name": "Query Alerts",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/alerts?createdDate=2022-03-19",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"alerts"
],
"query": [
{
"key": "createdDate",
"value": "2022-03-19"
}
]
}
},
"response": []
},
{
"name": "Query Running Totals",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/measurements/aggregations/metercode/",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"measurements",
"aggregations",
"metercode",
""
]
}
},
"response": []
}
]
},
{
"name": "Billing",
"item": [
{
"name": "List Bills",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/bills",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"bills"
]
}
},
"response": []
},
{
"name": "List BillsJobs",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/billjobs",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"billjobs"
]
}
},
"response": []
},
{
"name": "List Bills by Account",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/bills/accountid/5fb369ba-7aaf-435a-b442-0067bec2557e",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"bills",
"accountid",
"5fb369ba-7aaf-435a-b442-0067bec2557e"
]
}
},
"response": []
},
{
"name": "Create Billing",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"lastDateInBillingPeriod\": \"\",\n \"billingFrequency\": \"\",\n \"billFrequencyInterval\": 1\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/billjobs",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"billjobs"
]
}
},
"response": []
},
{
"name": "Preview Bill",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n\"version\": 0,\n\"billingFrequency\": \"\",\n\"billFrequencyInterval\": 1,\n\"billDate\": \"2022-02-01\",\n\"dueDate\": \"2022-05-31\",\n\"accountIds\": [\n\"\"\n],\n\"targetCurrency\": \"USD\",\n\"timezone\": \"UTC\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/bills/preview",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"bills",
"preview"
]
}
},
"response": []
},
{
"name": "Cancel BillJob",
"request": {
"method": "POST",
"header": [],
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/billjobs/UUID_HERE/cancel",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"billjobs",
"UUID_HERE",
"cancel"
]
}
},
"response": []
}
]
},
{
"name": "Data Explorer",
"item": [
{
"name": "Get Meters",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/dataexplorer/meters?startDate=2021-12-01T00:00:00Z&endDate=2021-12-02T00:00:00Z",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"dataexplorer",
"meters"
],
"query": [
{
"key": "startDate",
"value": "2021-12-01T00:00:00Z"
},
{
"key": "endDate",
"value": "2021-12-02T00:00:00Z"
}
]
}
},
"response": []
},
{
"name": "Get account values for querying bill line items",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/dataexplorer/bills/accounts",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"dataexplorer",
"bills",
"accounts"
]
}
},
"response": []
},
{
"name": "Get product values for querying bill line items",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/dataexplorer/bills/products",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"dataexplorer",
"bills",
"products"
]
}
},
"response": []
},
{
"name": "Get account values for querying commitments",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/dataexplorer/commitments/accounts",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"dataexplorer",
"commitments",
"accounts"
]
}
},
"response": []
},
{
"name": "Query and filter for bill line items",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"startDate\": \"2022-05-24T14:15:22Z\",\r\n \"endDate\": \"2022-08-24T14:15:22Z\",\r\n \"dimensions\": [\r\n {\r\n \"name\": \"string\",\r\n \"attributes\": [\r\n \"string\"\r\n ],\r\n \"filter\": [\r\n \"string\"\r\n ]\r\n }\r\n ],\r\n \"lineItemTypes\": [\r\n \"STANDING_CHARGE\"\r\n ],\r\n \"limit\": 1\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/dataexplorer/bills",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"dataexplorer",
"bills"
]
}
},
"response": []
},
{
"name": "Download Bill data as JSON (or CSV by changing the endpoint)",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"startDate\": \"2022-05-24T14:15:22Z\",\r\n \"endDate\": \"2022-08-24T14:15:22Z\",\r\n \"dimensions\": [\r\n {\r\n \"name\": \"string\",\r\n \"attributes\": [\r\n \"string\"\r\n ],\r\n \"filter\": [\r\n \"string\"\r\n ]\r\n }\r\n ],\r\n \"lineItemTypes\": [\r\n \"STANDING_CHARGE\"\r\n ],\r\n \"limit\": 1\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/dataexplorer/bills/download/json",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"dataexplorer",
"bills",
"download",
"json"
]
}
},
"response": []
},
{
"name": "Download Commitments data as JSON",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"startDate\": \"2022-05-24T14:15:22Z\",\r\n \"endDate\": \"2022-08-24T14:15:22Z\",\r\n \"dimensions\": [\r\n {\r\n \"name\": \"string\",\r\n \"attributes\": [\r\n \"string\"\r\n ],\r\n \"filter\": [\r\n \"string\"\r\n ]\r\n }\r\n ],\r\n \"limit\": 1\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/dataexplorer/commitments/download/json",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"dataexplorer",
"commitments",
"download",
"json"
]
}
},
"response": []
},
{
"name": "Download Commitments Obligations data as JSON",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"startDate\": \"2022-05-24T14:15:22Z\",\r\n \"endDate\": \"2022-08-24T14:15:22Z\",\r\n \"dimensions\": [\r\n {\r\n \"name\": \"string\",\r\n \"attributes\": [\r\n \"string\"\r\n ],\r\n \"filter\": [\r\n \"string\"\r\n ]\r\n }\r\n ],\r\n \"limit\": 1\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/dataexplorer/commitments/obligations/download/json",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"dataexplorer",
"commitments",
"obligations",
"download",
"json"
]
}
},
"response": []
},
{
"name": "Download Commitments line items data as JSON",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"startDate\": \"2022-05-24T14:15:22Z\",\r\n \"endDate\": \"2022-08-24T14:15:22Z\",\r\n \"dimensions\": [\r\n {\r\n \"name\": \"string\",\r\n \"attributes\": [\r\n \"string\"\r\n ],\r\n \"filter\": [\r\n \"string\"\r\n ]\r\n }\r\n ],\r\n \"limit\": 1\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/dataexplorer/commitments/lineitems/download/json",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"dataexplorer",
"commitments",
"lineitems",
"download",
"json"
]
}
},
"response": []
},
{
"name": "Download aggregated usage data as JSON",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"meterCodes\": [\r\n \"string\"\r\n ],\r\n \"startDate\": \"2022-05-24T14:15:22Z\",\r\n \"endDate\": \"2022-08-24T14:15:22Z\",\r\n \"aggregationFrequency\": \"WHOLE_PERIOD\",\r\n \"measures\": [\r\n {\r\n \"name\": \"string\",\r\n \"aggregations\": [\r\n \"SUM\"\r\n ]\r\n }\r\n ],\r\n \"dimensions\": [\r\n {\r\n \"name\": \"string\",\r\n \"attributes\": [\r\n \"string\"\r\n ],\r\n \"filter\": [\r\n \"string\"\r\n ]\r\n }\r\n ],\r\n \"limit\": 1\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/dataexplorer/usagedata/download/json",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"dataexplorer",
"usagedata",
"download",
"json"
]
}
},
"response": []
},
{
"name": "Query and filter for bill line items",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"accountCodes\": [\r\n \"string\"\r\n ],\r\n \"productNames\": [\r\n \"string\"\r\n ],\r\n \"limit\": 0\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/dataexplorer/bills/lineitemtypes",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"dataexplorer",
"bills",
"lineitemtypes"
]
}
},
"response": []
},
{
"name": "Query and filter for commitment line items",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"startDate\": \"2022-05-24T14:15:22Z\",\r\n \"endDate\": \"2022-08-24T14:15:22Z\",\r\n \"dimensions\": [\r\n {\r\n \"name\": \"string\",\r\n \"attributes\": [\r\n \"string\"\r\n ],\r\n \"filter\": [\r\n \"string\"\r\n ]\r\n }\r\n ],\r\n \"limit\": 1\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/dataexplorer/commitments/lineitems",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"dataexplorer",
"commitments",
"lineitems"
]
}
},
"response": []
},
{
"name": "Query and filter for obligations",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"startDate\": \"2022-05-24T14:15:22Z\",\r\n \"endDate\": \"2022-08-24T14:15:22Z\",\r\n \"dimensions\": [\r\n {\r\n \"name\": \"string\",\r\n \"attributes\": [\r\n \"string\"\r\n ],\r\n \"filter\": [\r\n \"string\"\r\n ]\r\n }\r\n ],\r\n \"limit\": 1\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/dataexplorer/commitments/obligations",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"dataexplorer",
"commitments",
"obligations"
]
}
},
"response": []
},
{
"name": "Query and filter for commitments",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"startDate\": \"2022-05-24T14:15:22Z\",\r\n \"endDate\": \"2022-08-24T14:15:22Z\",\r\n \"dimensions\": [\r\n {\r\n \"name\": \"string\",\r\n \"attributes\": [\r\n \"string\"\r\n ],\r\n \"filter\": [\r\n \"string\"\r\n ]\r\n }\r\n ],\r\n \"limit\": 1\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/dataexplorer/commitments",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"dataexplorer",
"commitments"
]
}
},
"response": []
},
{
"name": "Query and filter aggregated usage data",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"meterCodes\": [\r\n \"string\"\r\n ],\r\n \"startDate\": \"2022-05-24T14:15:22Z\",\r\n \"endDate\": \"2022-08-24T14:15:22Z\",\r\n \"aggregationFrequency\": \"MONTH\",\r\n \"measures\": [\r\n {\r\n \"name\": \"string\",\r\n \"aggregations\": [\r\n \"SUM\"\r\n ]\r\n }\r\n ],\r\n \"dimensions\": [\r\n {\r\n \"name\": \"string\",\r\n \"attributes\": [\r\n \"string\"\r\n ],\r\n \"filter\": [\r\n \"string\"\r\n ]\r\n }\r\n ],\r\n \"limit\": 1\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/dataexplorer/usagedata",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"dataexplorer",
"usagedata"
]
}
},
"response": []
},
{
"name": "Retrieve the values of a Meter Dimension",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\r\n \"meterCode\": \"string\",\r\n \"dimensionName\": \"string\",\r\n \"startDate\": \"2022-05-24T14:15:22Z\",\r\n \"endDate\": \"2022-08-24T14:15:22Z\",\r\n \"dimensions\": [\r\n {\r\n \"name\": \"string\",\r\n \"attributes\": [\r\n \"string\"\r\n ],\r\n \"filter\": [\r\n \"string\"\r\n ]\r\n }\r\n ],\r\n \"limit\": 1\r\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/dataexplorer/meterdimensions",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"dataexplorer",
"meterdimensions"
]
}
},
"response": []
},
{
"name": "Retrieve Meters stored in the Data Warehouse over a period of time",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/dataexplorer/meters?startDate=2022-06-01T00:00:00Z&endDate=2022-06-30T00:00:00Z",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"dataexplorer",
"meters"
],
"query": [
{
"key": "startDate",
"value": "2022-06-01T00:00:00Z"
},
{
"key": "endDate",
"value": "2022-06-30T00:00:00Z"
}
]
}
},
"response": []
},
{
"name": "Query and filter aggregated usage data",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n\"meterCodes\": [],\n\"startDate\": \"2022-06-29T00:00:00Z\",\n\"endDate\": \"2022-07-01T00:00:00Z\",\n\"aggregationFrequency\": \"ORIGINAL\",\n\"measures\": [\n{\n\"name\": \"\",\n\"aggregations\": []\n}\n],\n\"limit\": 3000\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/dataexplorer/usagedata",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"dataexplorer",
"usagedata"
]
}
},
"response": []
}
]
},
{
"name": "Alerts and Notifications",
"item": [
{
"name": "Available Event Types",
"protocolProfileBehavior": {
"disableBodyPruning": true
},
"request": {
"method": "GET",
"header": [],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/events/types",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"events",
"types"
]
}
},
"response": []
},
{
"name": "Available Event Types by Filter",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/events?eventName=configuration.commitment.created",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"events"
],
"query": [
{
"key": "eventName",
"value": "configuration.commitment.created"
},
{
"key": "notificationId",
"value": "",
"disabled": true
},
{
"key": "accountId",
"value": "",
"disabled": true
},
{
"key": "eventType",
"value": "",
"disabled": true
},
{
"key": "notificationCode",
"value": "",
"disabled": true
},
{
"key": "resourceId",
"value": "",
"disabled": true
},
{
"key": "ids",
"value": "",
"disabled": true
},
{
"key": "nextToken",
"value": "",
"disabled": true
},
{
"key": "pageSize",
"value": "",
"disabled": true
}
]
}
},
"response": []
},
{
"name": "Field Types",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/events/fields?eventName=configuration.commitment.updated",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"events",
"fields"
],
"query": [
{
"key": "eventName",
"value": "configuration.commitment.updated"
}
]
}
},
"response": []
},
{
"name": "Step 1: Create Notification Config",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"id\": \"uuid\",\n \"version\": 1,\n \"name\": \"Commitment has under 10% remaining\",\n \"description\": \"Commitment amount fell below 10%\",\n \"eventName\": \"configuration.commitment.updated\",\n \"calculation\": \"(new.amountSpent >= ((new.amount*100)/90)) AND ((old.amountSpent < ((old.amount*100)/90)) OR (old.amountSpent == null))\",\n \"code\" : \"under_10_percent_\",\n \"active\": true\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/notifications/configurations/",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"notifications",
"configurations",
""
]
}
},
"response": []
},
{
"name": "Step 2: Create Integration Destination",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"url\":\"https://some-url.net\",\n \"credentials\": {\n \"type\": \"M3TER_SIGNED_REQUEST\",\n \"destination\": \"Webhook\",\n \"apiKey\": \"apiKey\",\n \"secret\": \"some secret\"\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/integrationdestinations/webhooks",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"integrationdestinations",
"webhooks"
]
}
},
"response": []
},
{
"name": "Step 3: Create Integration Config",
"request": {
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"entityType\": \"Notification\",\n \"entityId\": \"id of the notification rule\",\n \"destination\": \"Webhook\",\n \"destinationId\": \"id of the destination\",\n \"configData\": {}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/integrationconfigs",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"integrationconfigs"
]
}
},
"response": []
}
]
},
{
"name": "Integrations",
"item": [
{
"name": "List External Mappings",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "eyJ0eXAiOiJKV1QiLCJwdCI6InNlcnZpY2UiLCJhbGciOiJSUzI1NiIsImtpZCI6InNlcnZpY2VVc2VyX2UyM2EwYTJlLTFkYzYtNGZkYy1hMDFlLWQyMzE2OTBlZDRjNyJ9.eyJzdWIiOiJjYzM4MTIzMi0xZDZlLTQ4ZDMtOTY0YS0yOWRmYzNjMmU4YjEiLCJwZXJtaXNzaW9ucyI6eyJNRUFTVVJFTUVOVFMjTUVBU1VSRU1FTlRTX1VQTE9BRCNJVEVNIyoiOnRydWV9LCJpc3MiOiJodHRwczpcL1wvbTN0ZXIuY29tXC9vYXV0aDIiLCJleHAiOjE2NzA1MjQzMjAsImlhdCI6MTY3MDUwNjMyMCwib3JnSWQiOiJlMjNhMGEyZS0xZGM2LTRmZGMtYTAxZS1kMjMxNjkwZWQ0YzcifQ.ZEeiaICrM1XE0hlRv8JTF9sQw0UrWbwVYxhWTNk5nDEck-7cltGJyDpbe6fevsTGjaDpSbRxPdcXPB5LsVOzsXH2qmx0x_6N5J9QJL19u9anle2Z1md1jF7yJB1TQym9x4PilZbW6vHJt78-WAKvxPiMGgxtF_vDZC5ZhBQVD7JKkHNJmmNFxLtjmTfwcObj_CVH4JkAJhTHOs1JKrQRT87_K5VqnDmpqtNbQ2t6HCFATevjOlDjn2UTfwHc3SSY1Qp895e-f_V5JmtYbTCd-9lgylUO5jO3UEp2SLQGpXV8XdlYWP1xExWxqeia8JVln4jn8BiBuhZjAhKtRiTfew",
"type": "string"
}
]
},
"method": "GET",
"header": [],
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/externalmappings/",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"externalmappings",
""
]
}
},
"response": []
},
{
"name": "Create External Mapping",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "eyJ0eXAiOiJKV1QiLCJwdCI6InNlcnZpY2UiLCJhbGciOiJSUzI1NiIsImtpZCI6InNlcnZpY2VVc2VyXzczYWYxNGE0LTVkNzQtNDdhNC1iZmU2LTU1Y2MyODI5NWRlZCJ9.eyJzdWIiOiI4MTlmZDM1ZS0wOWI4LTQxZjMtYmQzMi04NzVjZGJlYTliZGUiLCJwZXJtaXNzaW9ucyI6eyJNRUFTVVJFTUVOVFMjTUVBU1VSRU1FTlRTX1VQTE9BRCNJVEVNIyoiOnRydWV9LCJpc3MiOiJodHRwczpcL1wvbTN0ZXIuY29tXC9vYXV0aDIiLCJleHAiOjE2Njc0MDcyMTAsImlhdCI6MTY2NzM4OTIxMCwib3JnSWQiOiI3M2FmMTRhNC01ZDc0LTQ3YTQtYmZlNi01NWNjMjgyOTVkZWQifQ.VqmB6m0eU3qNndwydrsdyBQgQuC_6z3vZS47jmn-UVyBSpsc2pvB2OU3uDCuRgvOzGRmW1K3C8xyZ90gCXCd-m7Il18Xz1Jaasgtd4SUnBZlQwZxuZ2LLuAHwABzkhdd7hN5a-EEHs1FQE3nFxcDqJyQB9gajnyCmjLfKw7PXHcqVYouxvewi7hkIoeGEknu2LrwzigkorbsY7PUwSXpHYCf74YbN-Rzr04dBS26S7tmpxEhyFUc92crRVabs5DyqJpGl_RCP61mr8bOsaazrOrtDqsOQenS-SI6s2juLQR5FYe7lOK5cJkMulJ5jCA0FKaSVDlicivgyKu0o7QYtw",
"type": "string"
}
]
},
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"m3terEntity\": \"\",\n \"m3terId\": \"\",\n \"externalSystem\": \"\",\n \"externalTable\": \"\",\n \"externalId\": \"\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/externalmappings",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"externalmappings"
]
}
},
"response": []
}
]
},
{
"name": "Organization",
"item": [
{
"name": "Update Org Settings",
"request": {
"method": "PUT",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"version\": 1,\n \"timezone\": \"\",\n \"yearEpoch\": \"\",\n \"monthEpoch\": \"\",\n \"weekEpoch\": \"\",\n \"dayEpoch\": \"\",\n \"currency\": \"\",\n \"daysBeforeBillDue\": 30,\n \"scheduledBillInterval\": 0,\n \"standingChargeBillInAdvance\": false,\n \"commitmentFeeBillInAdvance\": false,\n \"minimumSpendBillInAdvance\": false\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/organizationconfig",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"organizationconfig"
]
}
},
"response": []
},
{
"name": "Get Org Settings",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "https://api.m3ter.com/organizations/{{org_id}}/organizationconfig",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"organizations",
"{{org_id}}",
"organizationconfig"
]
}
},
"response": []
}
]
},
{
"name": "Auth",
"item": [
{
"name": "Get Auth token",
"request": {
"auth": {
"type": "basic",
"basic": [
{
"key": "username",
"value": "",
"type": "string"
},
{
"key": "password",
"value": "",
"type": "string"
}
]
},
"method": "POST",
"header": [],
"body": {
"mode": "urlencoded",
"urlencoded": [
{
"key": "grant_type",
"value": "client_credentials",
"type": "text"
}
]
},
"url": {
"raw": "https://api.m3ter.com/oauth/token",
"protocol": "https",
"host": [
"api",
"m3ter",
"com"
],
"path": [
"oauth",
"token"
]
},
"description": "This collection updates the token for each API call automatically. However, you can build your authentication flow based on this example request."
},
"response": []
}
]
}
],
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{bearer_token}}",
"type": "string"
}
]
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"exec": [
"const moment = require('moment')",
"",
"const tokenUrl = pm.environment.get(\"root\") + '/oauth/token';",
"",
"let keys = pm.environment.get(\"access_key\") + \":\" + pm.environment.get(\"api_secret\");",
"let encodedKeys = CryptoJS.enc.Base64.stringify(CryptoJS.enc.Utf8.parse(keys));",
"",
"pm.environment.set(\"encodedKeys\", encodedKeys);",
"",
"const getTokenRequest = {",
"",
" method: 'POST',",
" url: tokenUrl,",
"",
" header: {",
" \"Content-Type\": \"application/x-www-form-urlencoded\",",
" \"Authorization\": \"Basic \" + pm.environment.get(\"encodedKeys\"),",
" },",
"",
" body: {",
" mode: \"urlencoded\",",
" \"urlencoded\": [",
" { \"key\": \"grant_type\", ",
" \"value\": \"client_credentials\",",
" \"type\": \"text\"}",
" ]",
" },",
"};",
"",
"var getToken = true",
"",
"if (!_.has(pm.environment.toObject(), 'AccessTokenExpiry') ",
" || !_.has(pm.environment.toObject(), 'bearer_token')",
" || pm.environment.get('AccessTokenExpiry') <= moment().valueOf()) {",
"} else {",
" getToken = false",
"}",
"",
"if (getToken) {",
" pm.sendRequest(getTokenRequest, (err, res) => {",
" if (err === null) {",
" pm.environment.set('bearer_token', `${res.json().access_token}`)",
" ",
" var expiryDate = moment().add(res.json().expires_in, 's').valueOf()",
" pm.environment.set('AccessTokenExpiry', expiryDate)",
" }",
" })",
"}"
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"exec": [
""
]
}
}
]
}