{
  "opencollection": "1.0.0",
  "info": {
    "name": "Bud API Services: Documentation Aggregation Buckets Enrichment Totals API",
    "version": "2.10.10"
  },
  "items": [
    {
      "info": {
        "name": "Enrichment Totals",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Retrieve Category Totals V2",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.thisisbud.com/aggregations/v2/totals/categories",
            "headers": [
              {
                "name": "X-Client-Id",
                "value": "8711bbef-b357-4c2d-97ca-0d9df4206e9a"
              },
              {
                "name": "X-Customer-Id",
                "value": "c3339af9-2426-44d4-9c4d-ddb8fd281e23"
              },
              {
                "name": "X-Customer-Idempotent-Identifier",
                "value": ""
              },
              {
                "name": "X-Customer-Secret",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "from",
                "value": "2023-05-21T07:20:50.52Z",
                "type": "query",
                "description": "The date from when results are to be retrieved in the format [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339).\n\nDefaults to 6 months ago.\n\nExamples:\n  - `2023-01-17T17:29:51Z`\n  - `2023-01-17T17:29:51-08:00`\n"
              },
              {
                "name": "to",
                "value": "2023-06-21T07:20:50.52Z",
                "type": "query",
                "description": "The date up to when results are to be retrieved in the format [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339).\n\nDefaults to today.\n\nExamples:\n  - `2023-03-17T17:29:51Z`\n  - `2023-03-17T17:29:51-08:00`\n"
              },
              {
                "name": "category",
                "value": "shopping",
                "type": "query",
                "description": "Use this parameter to filter the results on l1 categories to include.\nAccepts multiple values, or values separated by comma.\n\nTo specify l2 categories to include, use the following format: `l1.l2`.\n\nExamples:\n  - `shopping` - Filters the result set to only include data where the l1 category is `shopping`.\n  - `shopping.groceries` - Filters the result set to only include data where the l1 category is `shopping` and the l2 category is `groceries`.\n"
              },
              {
                "name": "exclude_category",
                "value": "shopping",
                "type": "query",
                "description": "Use this parameter to filter the results on l1 categories to exclude.\nAccepts multiple values, or values separated by comma.\n\nTo specify l2 categories to exclude, use the following format: `l1.l2`.\n\nExamples:\n  - `shopping` - Filters the result set to exclude data where the l1 category is `shopping`.\n  - `shopping.groceries` - Filters the result set to only exclude data where the l1 category is `shopping` and the l2 category is `groceries`.\n"
              },
              {
                "name": "currency",
                "value": "GBP",
                "type": "query",
                "description": "Use this parameter to filter the results returned on the `currency` associated with each result. Multiple values are accepted. If this parameter is not provided then results of any `currency` will be returned."
              },
              {
                "name": "account_id",
                "value": "",
                "type": "query",
                "description": "The account ID to retrieve data for."
              },
              {
                "name": "include_l2",
                "value": "true",
                "type": "query",
                "description": "Whether to include the L2 categories in result. Defaults to false."
              },
              {
                "name": "category_label",
                "value": "essential",
                "type": "query",
                "description": "Filters the categories included in the category totals to just those with the label(s) specified by this parameter.\nFor the SOT on which categories have which filters see the Retrieve Categories endpoint.\n"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/v1/oauth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Provides a customer’s total income and expenditure for each l1 and l2 category, over a given time period.\nL1 and l2 categories can be filtered using the category query parameter.\nExample:\n  - 'shopping'\n  - 'shopping.groceries'\n\nEach income and expenditure total is separated by currency, as we cannot sum totals in different currencies.\n"
        },
        {
          "info": {
            "name": "Retrieve Category Totals Trends",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.thisisbud.com/aggregations/v2/totals/categories/trends",
            "headers": [
              {
                "name": "X-Client-Id",
                "value": "8711bbef-b357-4c2d-97ca-0d9df4206e9a"
              },
              {
                "name": "X-Customer-Id",
                "value": "c3339af9-2426-44d4-9c4d-ddb8fd281e23"
              },
              {
                "name": "X-Customer-Idempotent-Identifier",
                "value": ""
              },
              {
                "name": "X-Customer-Secret",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "from",
                "value": "2023-05-21T07:20:50.52Z",
                "type": "query",
                "description": "The date from when results are to be retrieved in the format [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339).\n\nDefaults to 6 months ago.\n\nExamples:\n  - `2023-01-17T17:29:51Z`\n  - `2023-01-17T17:29:51-08:00`\n"
              },
              {
                "name": "to",
                "value": "2023-06-21T07:20:50.52Z",
                "type": "query",
                "description": "The date up to when results are to be retrieved in the format [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339).\n\nDefaults to today.\n\nExamples:\n  - `2023-03-17T17:29:51Z`\n  - `2023-03-17T17:29:51-08:00`\n"
              },
              {
                "name": "account_id",
                "value": "",
                "type": "query",
                "description": "The account ID to retrieve data for."
              },
              {
                "name": "currency",
                "value": "GBP",
                "type": "query",
                "description": "Use this parameter to filter the results returned on the `currency` associated with each result. Multiple values are accepted. If this parameter is not provided then results of any `currency` will be returned."
              },
              {
                "name": "category",
                "value": "shopping",
                "type": "query",
                "description": "Use this parameter to filter the results on l1 categories to include.\nAccepts multiple values, or values separated by comma.\n\nTo specify l2 categories to include, use the following format: `l1.l2`.\n\nExamples:\n  - `shopping` - Filters the result set to only include data where the l1 category is `shopping`.\n  - `shopping.groceries` - Filters the result set to only include data where the l1 category is `shopping` and the l2 category is `groceries`.\n"
              },
              {
                "name": "exclude_category",
                "value": "shopping",
                "type": "query",
                "description": "Use this parameter to filter the results on l1 categories to exclude.\nAccepts multiple values, or values separated by comma.\n\nTo specify l2 categories to exclude, use the following format: `l1.l2`.\n\nExamples:\n  - `shopping` - Filters the result set to exclude data where the l1 category is `shopping`.\n  - `shopping.groceries` - Filters the result set to only exclude data where the l1 category is `shopping` and the l2 category is `groceries`.\n"
              },
              {
                "name": "include_l2",
                "value": "true",
                "type": "query",
                "description": "Whether to include the L2 categories in result. Defaults to false."
              },
              {
                "name": "granularity",
                "value": "monthly",
                "type": "query",
                "description": "Specifies in what interval the balance over time should be retrieved.\n\nCurrently supported values include (but are not necessarily limited to):\n  - `daily`\n  - `weekly`\n  - `biweekly`\n  - `monthly`\n  - `quarterly`\n  - `six_monthly`\n  - `annually`\n\n  Defaults to `monthly`.\n"
              },
              {
                "name": "category_label",
                "value": "essential",
                "type": "query",
                "description": "Filters the categories included in the category totals to just those with the label(s) specified by this parameter.\nFor the SOT on which categories have which filters see the Retrieve Categories endpoint.\n"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/v1/oauth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Provides category totals for desired categories over a given time period of time with a given granularity.\n\nL1 and l2 categories can be filtered using the category query parameter.\nExample:\n  - 'shopping'\n  - 'shopping.groceries'\nEach income and expenditure total is separated by currency, as we cannot sum totals in different currencies.\n\nCan be used for producing graphs of category totals over time.\n"
        },
        {
          "info": {
            "name": "Retrieve Statistics For Essential Total Spend",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.thisisbud.com/aggregations/v2/totals/essential-statistics",
            "headers": [
              {
                "name": "X-Client-Id",
                "value": "8711bbef-b357-4c2d-97ca-0d9df4206e9a"
              },
              {
                "name": "X-Customer-Id",
                "value": "c3339af9-2426-44d4-9c4d-ddb8fd281e23"
              },
              {
                "name": "X-Customer-Idempotent-Identifier",
                "value": ""
              },
              {
                "name": "X-Customer-Secret",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "from",
                "value": "2023-05-21T07:20:50.52Z",
                "type": "query",
                "description": "The date from when results are to be retrieved in the format [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339).\n\nDefaults to 6 months ago.\n\nExamples:\n  - `2023-01-17T17:29:51Z`\n  - `2023-01-17T17:29:51-08:00`\n"
              },
              {
                "name": "to",
                "value": "2023-06-21T07:20:50.52Z",
                "type": "query",
                "description": "The date up to when results are to be retrieved in the format [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339).\n\nDefaults to today.\n\nExamples:\n  - `2023-03-17T17:29:51Z`\n  - `2023-03-17T17:29:51-08:00`\n"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/v1/oauth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Provides a few useful statistics which allow you to quickly see a customers total essential and non essential spend.\n\nWill also allow you to see this spend as a percentage of overall spend.\n"
        },
        {
          "info": {
            "name": "Retrieve Merchant Totals V2",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-sandbox.thisisbud.com/v2/merchants/totals",
            "headers": [
              {
                "name": "X-Client-Id",
                "value": "8711bbef-b357-4c2d-97ca-0d9df4206e9a"
              },
              {
                "name": "X-Customer-Id",
                "value": "c3339af9-2426-44d4-9c4d-ddb8fd281e23"
              },
              {
                "name": "X-Customer-Idempotent-Identifier",
                "value": ""
              },
              {
                "name": "X-Customer-Secret",
                "value": ""
              },
              {
                "name": "X-From",
                "value": "2022-02-28"
              },
              {
                "name": "X-To",
                "value": "2022-01-28"
              },
              {
                "name": "X-Include-Categories",
                "value": "shopping,entertainment"
              },
              {
                "name": "X-Exclude-Categories",
                "value": "bills,finances"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/v1/oauth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Provides a customer’s total debit and credit amounts for each merchant.\n"
        }
      ]
    }
  ],
  "bundled": true
}