Skip to main content
GET
/
api
/
v1
/
share
/
{shareId}
/
analytics
Retrieve share analytics
curl --request GET \
  --url https://handauncle-backend-prod-205012263523.asia-south1.run.app/api/v1/share/{shareId}/analytics \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": {
    "shareId": "<string>",
    "totalViews": 123,
    "uniqueViewers": 123,
    "continuationCount": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "lastViewedAt": "2023-11-07T05:31:56Z",
    "viewTimeline": [
      {
        "date": "<string>",
        "views": 123
      }
    ],
    "viewerLocations": [
      {
        "country": "<string>",
        "count": 123
      }
    ]
  },
  "meta": {
    "timestamp": "2023-11-07T05:31:56Z",
    "requestId": "<string>"
  }
}
Returns rollups for a specific share: total views, unique viewers, continuation count, last viewed timestamp, and (optionally) viewer timelines/locations. Requires share ownership plus a valid Auth0 access token.

Authorizations

Authorization
string
header
required

Auth0 access token for registered users.

Path Parameters

shareId
string
required

Share identifier returned by POST /api/v1/share.

Required string length: 8 - 64

Query Parameters

include_viewers
boolean
default:false
time_range
enum<string>
default:all
Available options:
24h,
7d,
30d,
all

Response

Analytics returned.

success
enum<boolean>
required
Available options:
true
data
object
required
meta
object
required