{
  "opencollection": "1.0.0",
  "info": {
    "name": "Swetrix Admin Annotations Traffic API",
    "version": "1.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "X-Api-Key",
      "value": "{{X-Api-Key}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Traffic",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get Traffic Log",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.swetrix.com/v1/log",
            "params": [
              {
                "name": "pid",
                "value": "",
                "type": "query",
                "description": "Project ID"
              },
              {
                "name": "timeBucket",
                "value": "",
                "type": "query",
                "description": "Time bucket for data aggregation"
              },
              {
                "name": "period",
                "value": "",
                "type": "query",
                "description": "Time period for the query"
              },
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "Custom range start date (YYYY-MM-DD)"
              },
              {
                "name": "to",
                "value": "",
                "type": "query",
                "description": "Custom range end date (YYYY-MM-DD)"
              },
              {
                "name": "timezone",
                "value": "",
                "type": "query",
                "description": "IANA timezone name (default Etc/GMT)"
              },
              {
                "name": "filters",
                "value": "",
                "type": "query",
                "description": "JSON array of filter objects"
              },
              {
                "name": "mode",
                "value": "",
                "type": "query",
                "description": "Data aggregation mode"
              },
              {
                "name": "metrics",
                "value": "",
                "type": "query",
                "description": "Up to 3 custom metric objects (JSON array)"
              }
            ]
          },
          "docs": "Retrieves aggregated traffic data for a project. Returns the same data shown in the Traffic tab of the dashboard, represented as JSON. Supports periodic or cumulative modes and custom metric objects."
        },
        {
          "info": {
            "name": "Get Birdseye Traffic Summary",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.swetrix.com/v1/log/birdseye",
            "params": [
              {
                "name": "pids",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of project IDs (use pid or pids)"
              },
              {
                "name": "pid",
                "value": "",
                "type": "query",
                "description": "Project ID"
              },
              {
                "name": "period",
                "value": "",
                "type": "query",
                "description": "Time period for the query"
              },
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "Custom range start date (YYYY-MM-DD)"
              },
              {
                "name": "to",
                "value": "",
                "type": "query",
                "description": "Custom range end date (YYYY-MM-DD)"
              },
              {
                "name": "timezone",
                "value": "",
                "type": "query",
                "description": "IANA timezone name (default Etc/GMT)"
              },
              {
                "name": "filters",
                "value": "",
                "type": "query",
                "description": "JSON array of filter objects"
              }
            ]
          },
          "docs": "Returns summary traffic data for one or more projects, comparing the current period against the previous period. Useful for dashboards showing traffic trends."
        },
        {
          "info": {
            "name": "Get Live Visitors",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.swetrix.com/v1/log/live-visitors",
            "params": [
              {
                "name": "pid",
                "value": "",
                "type": "query",
                "description": "Project ID"
              }
            ]
          },
          "docs": "Returns currently active visitors on a project. Each visitor record includes device type, browser, operating system, country, and session ID."
        },
        {
          "info": {
            "name": "Get Search Keywords",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.swetrix.com/v1/log/keywords",
            "params": [
              {
                "name": "pid",
                "value": "",
                "type": "query",
                "description": "Project ID"
              },
              {
                "name": "period",
                "value": "",
                "type": "query",
                "description": "Time period for the query"
              },
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "Custom range start date (YYYY-MM-DD)"
              },
              {
                "name": "to",
                "value": "",
                "type": "query",
                "description": "Custom range end date (YYYY-MM-DD)"
              },
              {
                "name": "timezone",
                "value": "",
                "type": "query",
                "description": "IANA timezone name (default Etc/GMT)"
              }
            ]
          },
          "docs": "Returns search keyword data from Google Search Console integration for the specified project and period."
        },
        {
          "info": {
            "name": "Get User Navigation Flow",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.swetrix.com/v1/log/user-flow",
            "params": [
              {
                "name": "pid",
                "value": "",
                "type": "query",
                "description": "Project ID"
              },
              {
                "name": "timeBucket",
                "value": "",
                "type": "query",
                "description": "Time bucket for data aggregation"
              },
              {
                "name": "period",
                "value": "",
                "type": "query",
                "description": "Time period for the query"
              },
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "Custom range start date (YYYY-MM-DD)"
              },
              {
                "name": "to",
                "value": "",
                "type": "query",
                "description": "Custom range end date (YYYY-MM-DD)"
              },
              {
                "name": "timezone",
                "value": "",
                "type": "query",
                "description": "IANA timezone name (default Etc/GMT)"
              },
              {
                "name": "filters",
                "value": "",
                "type": "query",
                "description": "JSON array of filter objects"
              }
            ]
          },
          "docs": "Returns user navigation flow diagram data showing how visitors move between pages on the site."
        },
        {
          "info": {
            "name": "Get Available Filter Values",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.swetrix.com/v1/log/filters",
            "params": [
              {
                "name": "pid",
                "value": "",
                "type": "query",
                "description": "Project ID"
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "Dimension type to get filter values for"
              }
            ]
          },
          "docs": "Returns available filter values for a specific analytics dimension such as browser, OS, or country code."
        }
      ]
    }
  ],
  "bundled": true
}