GET
/
v2
/
farcaster
/
frame
/
validate
/
analytics
/
Analytics for the mini app
curl --request GET \
  --url https://api.neynar.com/v2/farcaster/frame/validate/analytics/ \
  --header 'x-api-key: <api-key>'
{
  "interactors": [
    {
      "fid": 3,
      "username": "<string>",
      "interaction_count": 123
    }
  ]
}

Authorizations

​
x-api-key
string
header
default:NEYNAR_API_DOCS
required

API key to authorize requests

Query Parameters

​
frame_url
string<uri>
required

URL of the mini app to fetch analytics for

Example:

"https://shorturl.at/bDRY9"

​
analytics_type
enum<string>
required

Type of analytics to fetch

Available options:
total-interactors,
interactors,
interactions-per-cast,
input-text
​
start
string<date-time>
required
Example:

"2024-04-06T06:44:56.811Z"

​
stop
string<date-time>
required
Example:

"2024-04-08T06:44:56.811Z"

​
aggregate_window
enum<string>

Required for analytics_type=interactions-per-cast

Available options:
10s,
1m,
2m,
5m,
10m,
20m,
30m,
2h,
12h,
1d,
7d

Response

200
application/json

Success

The response is of type object.