GET
/
interactions
curl --request GET \
  --url https://api.pinata.cloud/farcaster/frames/interactions \
  --header 'Authorization: Bearer <token>'
{
  "total_interactions": 73,
  "total_unique_interactions": 20,
  "time_periods": [
    {
      "period_start_time": "2024-03-15 00:00:00",
      "interactions": 71,
      "unique_interactions": 18
    },
    {
      "period_start_time": "2024-03-17 00:00:00",
      "interactions": 1,
      "unique_interactions": 1
    },
    {
      "period_start_time": "2024-03-18 00:00:00",
      "interactions": 1,
      "unique_interactions": 1
    }
  ]
}

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

start_date
string

Date format of YYYY-MM-DD HH:MM:SS

end_date
string

Date format of YYYY-MM-DD HH:MM:SS

frame_id
string

Get interactions for a set frame_id

button_index
integer

Get interactions by button_index

url
string

Get interactions by frame url

custom_id
string

Get interactions by custom_id

Response

200 - application/json

The response is of type object.