Add listing sites, goals and custom props to Sites API

zoldar commented 2 days ago

Changes

This PR extends Sites API in following ways:

add GET /api/v1/sites endpoint listing all sites the API key owner has access to
add GET /api/v1/sites/goals endpoint listing all goals for a given site_id
extend GET /api/v1/sites/:site_id endpoint with allowed_custom_props field listing all custom properties allowed for a given site

The list endpoints implement cursor based pagination. They accept following parameters: before, after and limit (defaults to 10, capped at 100 as max). The response payload always contains pagination metadata:

{
  "sites": [...],
  "meta": {
    "after": "Z2xc...",
    "before": null,
    "limit": 10
  }
}

After the initial request, previous and next pages can be retrieved by repeating the same request with before or after query parameter added from the last response. The limit parameter must remain the same when paginating (either at default or the same value must be passed each time explicitly). The null value in before or after means there are no more either previous or next pages to navigate to.

There are no breaking changes to the API and the new extensions follow existing path and data shape conventions.

Tests

[x] Automated tests have been added

Changelog

[x] This PR does not make a user-facing change

Documentation

[ ] Docs have been updated
[ ] This change does not need a documentation update

Dark mode

[x] This PR does not change the UI

github-actions[bot] commented 1 day ago

github-actions[bot] commented 1 day ago

macobo commented 1 day ago

100 seems quite low as a maximum limit and 10 as a default - why not 100 as default and 1000 as maximum? The query and response sizes are quite minimal and we're just inconveniencing users.

zoldar commented 23 hours ago

100 seems quite low as a maximum limit and 10 as a default - why not 100 as default and 1000 as maximum? The query and response sizes are quite minimal and we're just inconveniencing users.

Yes, I guess those could be bumped. The current limits are what's currently in effect for Plugin API.

zoldar commented 23 hours ago

Bumped pagination limits in https://github.com/plausible/analytics/pull/4302/commits/93b3c571491f1571f741620ad6814663d434a59e

github-actions[bot] commented 22 hours ago

plausible / analytics