https://github.com/versecafe/vaas

VAAS: The Vercel Analytics API Scraper
https://github.com/versecafe/vaas

Last synced: 3 months ago
JSON representation

VAAS: The Vercel Analytics API Scraper

• Host: GitHub
• URL: https://github.com/versecafe/vaas
• Owner: versecafe
• Created: 2024-04-23T08:55:27.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-06-02T01:18:38.000Z (8 months ago)
• Last Synced: 2024-06-02T01:53:21.703Z (8 months ago)
• Language: TypeScript
• Homepage: https://vaas-brown.vercel.app
• Size: 412 KB
• Stars: 6
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# VAAS

Retrieving your Vercel Analytics data for external use has never been easier.





## Get back data in your prefered format

JSON

CSV

YAML

XML

TOML

```json

[

  {

    "key": "2024-03-24",

    "views": 32,

    "visitors": 24

  },

  {

    "key": "2024-03-25",

    "views": 183,

    "visitors": 72

  },

  {

    "key": "2024-03-26",

    "views": 569,

    "visitors": 216

  }

]

```

```csv

key,total,devices

2024-03-24,32,24

2024-03-25,183,72

2024-03-26,569,216

```

```yaml

dataset:

  - key: 2024-03-24

    total: 32

    devices: 24

  - key: 2024-03-25

    total: 183

    devices: 72

  - key: 2024-03-26

    total: 569

    devices: 216

```

```xml

  

    2024-03-24

    32

    24

  

  

    2024-03-25

    183

    72

  

  

    2024-03-26

    569

    216

  

```

```toml

[[data]]

key = "2024-03-24"

total = 32

devices = 24

[[data]]

key = "2024-03-25"

total = 183

devices = 72

[[data]]

key = "2024-03-26"

total = 569

devices = 216

```

## Filters

### Basic Filter Options

```json

{"path":{"values":["/path/to/page"],"operator":"eq"}}

{ "referrer": { "values": ["https://duckduckgo.com"], "operator": "eq" } }

{ "country": { "values": ["US"], "operator": "eq" } }

{ "device": { "values": ["Desktop"], "operator": "eq" } }

{ "os": { "values": ["Mac"], "operator": "eq" } }

{ "browser": { "values": ["Chrome"], "operator": "eq" } }

{ "event_name": { "values": ["Event"], "operator": "eq" } }

{ "event_data": { "properties": { "quiz": "Property Name" }, "operator": "eq" }

```

### Building advanced filter queries

```json

{ "event_name": { "values": ["Test Submission"], "operator": "eq" } }

```

Filter further by specific event properties

```json

{

  "event_name": { "values": ["Test Submission"], "operator": "eq" },

  "event_data": {

    "properties": { "quiz": "MV2G Intelligence Assessment" },

    "operator": "eq"

  }

}

```

Add external filter such as Nation

```json

{

  "event_name": { "values": ["Test Submission"], "operator": "eq" },

  "event_data": {

    "properties": { "quiz": "MV2G Intelligence Assessment" },

    "operator": "eq"

  },

  "country": { "values": ["US"], "operator": "eq" }

}

```

## Run it yourself

Vaas has no env vars, so all you need to do is clone the repo and run the following commands:

```bash

bun i && bun dev

```