{
  "opencollection": "1.0.0",
  "info": {
    "name": "MX Platform accounts insights API",
    "version": "20111101"
  },
  "request": {
    "auth": {
      "type": "basic",
      "username": "{{username}}",
      "password": "{{password}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "insights",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List insights by account",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://int-api.mx.com/users/:user_guid/accounts/:account_guid/insights",
            "params": [
              {
                "name": "account_guid",
                "value": "ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1",
                "type": "path",
                "description": "The unique id for an `account`."
              },
              {
                "name": "user_guid",
                "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
                "type": "path",
                "description": "The unique identifier for a `user`, beginning with the prefix `USR-`."
              },
              {
                "name": "page",
                "value": "1",
                "type": "query",
                "description": "Results are paginated. Specify current page."
              },
              {
                "name": "records_per_page",
                "value": "10",
                "type": "query",
                "description": "This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `100`. If the value exceeds `100`, the default value of `25` will be used instead."
              }
            ]
          },
          "docs": "Use this endpoint to list all insights associated with an account GUID."
        },
        {
          "info": {
            "name": "List all insights for a user",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://int-api.mx.com/users/:user_guid/insights",
            "params": [
              {
                "name": "user_guid",
                "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
                "type": "path",
                "description": "The unique identifier for a `user`, beginning with the prefix `USR-`."
              },
              {
                "name": "page",
                "value": "1",
                "type": "query",
                "description": "Results are paginated. Specify current page."
              },
              {
                "name": "records_per_page",
                "value": "10",
                "type": "query",
                "description": "This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `100`. If the value exceeds `100`, the default value of `25` will be used instead."
              }
            ]
          },
          "docs": "Use this endpoint to list all the insights associated with the user."
        },
        {
          "info": {
            "name": "List all categories associated with an insight",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://int-api.mx.com/users/:user_guid/insights/:insight_guid/categories",
            "params": [
              {
                "name": "user_guid",
                "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
                "type": "path",
                "description": "The unique identifier for a `user`, beginning with the prefix `USR-`."
              },
              {
                "name": "insight_guid",
                "value": "BET-1234-abcd",
                "type": "path",
                "description": "The unique identifier for the insight. Defined by MX."
              },
              {
                "name": "page",
                "value": "1",
                "type": "query",
                "description": "Results are paginated. Specify current page."
              },
              {
                "name": "records_per_page",
                "value": "10",
                "type": "query",
                "description": "This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `100`. If the value exceeds `100`, the default value of `25` will be used instead."
              }
            ]
          },
          "docs": "Use this endpoint to list all the categories associated with the insight."
        },
        {
          "info": {
            "name": "List all accounts associated with an insight",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://int-api.mx.com/users/:user_guid/insights/:insight_guid/accounts",
            "params": [
              {
                "name": "user_guid",
                "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
                "type": "path",
                "description": "The unique identifier for a `user`, beginning with the prefix `USR-`."
              },
              {
                "name": "insight_guid",
                "value": "BET-1234-abcd",
                "type": "path",
                "description": "The unique identifier for the insight. Defined by MX."
              },
              {
                "name": "page",
                "value": "1",
                "type": "query",
                "description": "Results are paginated. Specify current page."
              },
              {
                "name": "records_per_page",
                "value": "10",
                "type": "query",
                "description": "This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `100`. If the value exceeds `100`, the default value of `25` will be used instead."
              }
            ]
          },
          "docs": "Use this endpoint to list all the accounts associated with the insight."
        },
        {
          "info": {
            "name": "List all merchants associated with an insight",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://int-api.mx.com/users/:user_guid/insights/:insight_guid/merchants",
            "params": [
              {
                "name": "user_guid",
                "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
                "type": "path",
                "description": "The unique identifier for a `user`, beginning with the prefix `USR-`."
              },
              {
                "name": "insight_guid",
                "value": "BET-1234-abcd",
                "type": "path",
                "description": "The unique identifier for the insight. Defined by MX."
              },
              {
                "name": "page",
                "value": "1",
                "type": "query",
                "description": "Results are paginated. Specify current page."
              },
              {
                "name": "records_per_page",
                "value": "10",
                "type": "query",
                "description": "This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `100`. If the value exceeds `100`, the default value of `25` will be used instead."
              }
            ]
          },
          "docs": "Use this endpoint to list all the merchants associated with the insight."
        },
        {
          "info": {
            "name": "List all scheduled payments associated with an insight",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://int-api.mx.com/users/:user_guid/insights/:insight_guid/scheduled_payments",
            "params": [
              {
                "name": "user_guid",
                "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
                "type": "path",
                "description": "The unique identifier for a `user`, beginning with the prefix `USR-`."
              },
              {
                "name": "insight_guid",
                "value": "BET-1234-abcd",
                "type": "path",
                "description": "The unique identifier for the insight. Defined by MX."
              },
              {
                "name": "page",
                "value": "1",
                "type": "query",
                "description": "Results are paginated. Specify current page."
              },
              {
                "name": "records_per_page",
                "value": "10",
                "type": "query",
                "description": "This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `100`. If the value exceeds `100`, the default value of `25` will be used instead."
              }
            ]
          },
          "docs": "Use this endpoint to list all the scheduled payments associated with the insight."
        },
        {
          "info": {
            "name": "List all transactions associated with an insight",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://int-api.mx.com/users/:user_guid/insights/:insight_guid/transactions",
            "params": [
              {
                "name": "user_guid",
                "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
                "type": "path",
                "description": "The unique identifier for a `user`, beginning with the prefix `USR-`."
              },
              {
                "name": "insight_guid",
                "value": "BET-1234-abcd",
                "type": "path",
                "description": "The unique identifier for the insight. Defined by MX."
              },
              {
                "name": "page",
                "value": "1",
                "type": "query",
                "description": "Results are paginated. Specify current page."
              },
              {
                "name": "records_per_page",
                "value": "10",
                "type": "query",
                "description": "This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `100`. If the value exceeds `100`, the default value of `25` will be used instead."
              }
            ]
          },
          "docs": "Use this endpoint to list all the transactions associated with the insight."
        },
        {
          "info": {
            "name": "Read insight",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://int-api.mx.com/users/:user_guid/insights/:insight_guid",
            "params": [
              {
                "name": "user_guid",
                "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
                "type": "path",
                "description": "The unique identifier for a `user`, beginning with the prefix `USR-`."
              },
              {
                "name": "insight_guid",
                "value": "BET-1234-abcd",
                "type": "path",
                "description": "The unique identifier for the insight. Defined by MX."
              }
            ]
          },
          "docs": "Use this endpoint to read the attributes of an insight according to its unique GUID."
        },
        {
          "info": {
            "name": "Update insight",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://int-api.mx.com/users/:user_guid/insights/:insight_guid",
            "params": [
              {
                "name": "user_guid",
                "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
                "type": "path",
                "description": "The unique identifier for a `user`, beginning with the prefix `USR-`."
              },
              {
                "name": "insight_guid",
                "value": "BET-1234-abcd",
                "type": "path",
                "description": "The unique identifier for the insight. Defined by MX."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Use this endpoint to update the attributes of an insight according to its unique GUID."
        },
        {
          "info": {
            "name": "List insights by transaction",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://int-api.mx.com/users/:user_guid/transactions/:transaction_guid/insights",
            "params": [
              {
                "name": "transaction_guid",
                "value": "TRN-810828b0-5210-4878-9bd3-f4ce514f90c4",
                "type": "path",
                "description": "The unique id for a `transaction`."
              },
              {
                "name": "user_guid",
                "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
                "type": "path",
                "description": "The unique identifier for a `user`, beginning with the prefix `USR-`."
              },
              {
                "name": "page",
                "value": "1",
                "type": "query",
                "description": "Results are paginated. Specify current page."
              },
              {
                "name": "records_per_page",
                "value": "10",
                "type": "query",
                "description": "This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `100`. If the value exceeds `100`, the default value of `25` will be used instead."
              }
            ]
          },
          "docs": "Use this endpoint to list all insights associated with a transaction GUID."
        }
      ]
    }
  ],
  "bundled": true
}