REST API quickstart

1. Create a server-side credential#

Generate a read-only API key for your site and save its one-time secret. The public base URL is https://weeveo.com. Self-hosted installations use their own configured HTTPS origin.

2. Discover your projects#

curl https://weeveo.com/api/v1/tools/list_projects \
  -H "Authorization: Bearer $WEEVEO_API_KEY"

The response uses { "tool": "list_projects", "result": ... }. API keys default to their own site. For an authorized OAuth credential covering multiple sites, explicitly pass projectId in site-specific calls.

3. Query a report#

curl https://weeveo.com/api/v1/tools/get_traffic_summary \
  -H "Authorization: Bearer $WEEVEO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"range":"30d","traffic":"human","compare":true}'

POST accepts a JSON object of arguments and returns { tool, result }. GET is supported only for read tools and converts simple boolean/numeric query values. Use POST for arrays and nested objects. The body limit is 65,536 characters as checked by the route.

4. Handle errors#

Check the HTTP status and { error } response. Authentication failure is different from a valid credential without project/role/write access. Never retry destructive writes blindly. See errors and limits.

5. Choose a tool#

The tool reference contains every registered tool and exact input schema. Authenticated GET /api/v1/tools returns the runtime catalog. The public JSON catalog contains documentation schemas only and never runs a tool.