Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API for exposing top pages metrics for a specific site #461

Open
iuliag opened this issue Aug 22, 2024 · 0 comments
Open

API for exposing top pages metrics for a specific site #461

iuliag opened this issue Aug 22, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@iuliag
Copy link
Contributor

iuliag commented Aug 22, 2024

Is your feature request related to a problem? Please describe.
Implement API for exposing top pages metrics for a specific site

Describe the solution you'd like
API endpoint for exposing top pages metrics for a specific site.
Be able to get:

  • all of them
  • for a specific source only
  • for a specific source and geo only

API spec proposed in #292, https://opensource.adobe.com/spacecat-api-service/#tag/top-pages/operation/getSiteTopPages

Or we can align with the site metrics by source API https://opensource.adobe.com/spacecat-api-service/#tag/experimental/operation/getSiteMetricsBySource and have something along the lines of:

GET /sites/{siteId}/top-pages/metrics/{metric}/{source}
GET /sites/{siteId}/top-pages/metrics/organic-traffic
GET /sites/{siteId}/top-pages/metrics/organic-traffic/ahrefs
GET /sites/{siteId}/top-pages/metrics/organic-traffic/ahrefs/au

[
  {
    "siteId": "a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14",
    "source": "ahrefs",
    "name": "organic-traffic",
    "value": 37900,
    "time": "2024-04-29T00:00:00.000Z"
    "geo": "au",
    "url": "https://example-site.com/foo/bar"
  }
]
@iuliag iuliag added the enhancement New feature or request label Aug 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant