App Analytics — Hypery Docs

Overview

Track how your OAuth app is being used.

Authentication: OAuth token
Required Scopes: apps:read

Get App Analytics

View detailed usage statistics.

Endpoint: GET /api/apps/:id/analytics

const response = await fetch(
  `https://hypery.ai/api/apps/${appId}/analytics`,
  { headers: { 'Authorization': `Bearer ${oauthToken}` } }
)
 
const { analytics } = await response.json()

response = requests.get(
    f'https://hypery.ai/api/apps/{app_id}/analytics',
    headers={'Authorization': f'Bearer {oauth_token}'}
)
 
analytics = response.json()['analytics']

curl https://hypery.ai/api/apps/APP_ID/analytics \
  -H "Authorization: Bearer OAUTH_TOKEN"

Response:

{
  "success": true,
  "analytics": {
    "totalRequests": 5420,
    "totalUsers": 127,
    "totalCost": 234,
    "period": "month",
    "breakdown": {
      "chat": 4200,
      "images": 1220
    },
    "topModels": [
      {
        "model": "anthropic/claude-3.5-sonnet",
        "requests": 3100,
        "cost": 156
      }
    ]
  }
}

Output Fields

Field	Type	Description
`totalRequests`	number	Total API calls
`totalUsers`	number	Unique users
`totalCost`	number	Total credits spent
`period`	string	Time period (`day`, `week`, `month`)
`breakdown`	object	Requests by API type
`topModels`	array	Most used models

Get Engagement Metrics

View user engagement statistics.

Endpoint: GET /api/apps/:id/engagement

const response = await fetch(
  `https://hypery.ai/api/apps/${appId}/engagement`,
  { headers: { 'Authorization': `Bearer ${oauthToken}` } }
)
 
const { engagement } = await response.json()

response = requests.get(
    f'https://hypery.ai/api/apps/{app_id}/engagement',
    headers={'Authorization': f'Bearer {oauth_token}'}
)

curl https://hypery.ai/api/apps/APP_ID/engagement \
  -H "Authorization: Bearer OAUTH_TOKEN"

Get App Status

Check app approval status.

Endpoint: GET /api/apps/:id/status

const response = await fetch(
  `https://hypery.ai/api/apps/${appId}/status`,
  { headers: { 'Authorization': `Bearer ${oauthToken}` } }
)
 
const { status } = await response.json()
console.log(status)  // "draft", "pending", "approved", "rejected"

response = requests.get(
    f'https://hypery.ai/api/apps/{app_id}/status',
    headers={'Authorization': f'Bearer {oauth_token}'}
)
 
status = response.json()['status']

curl https://hypery.ai/api/apps/APP_ID/status \
  -H "Authorization: Bearer OAUTH_TOKEN"

Status values:

draft - Not submitted for review
pending - Under review
approved - Live and available
rejected - Rejected (see rejection reason)

Transfer App

Transfer app ownership to another team.

Endpoint: POST /api/apps/:id/transfer

await fetch(`https://hypery.ai/api/apps/${appId}/transfer`, {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${oauthToken}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    teamId: 'new_team_id'
  })
})

requests.post(
    f'https://hypery.ai/api/apps/{app_id}/transfer',
    headers={'Authorization': f'Bearer {oauth_token}'},
    json={'teamId': 'new_team_id'}
)

curl -X POST https://hypery.ai/api/apps/APP_ID/transfer \
  -H "Authorization: Bearer OAUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"teamId": "new_team_id"}'

Input Parameters

Parameter	Type	Required	Description
`teamId`	string	Yes	Destination team ID

Next Steps

Apps

Back to Apps API

Teams

Manage teams