List displays
List popups, flyouts, bars and other displays with status, views and signups.
GET https://cotlet.dev/api/v1/privy/displays
read
Returns each display with its type, status, Views, Signups and Signup Rate, the numbers Privy shows on its card. Views counts a display appearing on a visitor's screen, not a pageview, and a signup is a submitted form. Orders and revenue are not returned.
Parameters
| Name | Type | Description |
|---|---|---|
| status string | string | draft, scheduled, live, paused, ended or archived. Archived displays appear only when you ask for them |
| page integer | integer | Page number, starting at 1 |
| per_page integer | integer | Items per page |
Request
curl https://cotlet.dev/api/v1/privy/displays \
-H "Authorization: Bearer $COTLET_API_KEY"result = client.call("privy", "list_displays")const result = await cotlet.call('privy', 'list_displays');cotlet call privy list_displaysExample response
{
"data": [
{
"id": "dsp_c3e0",
"title": "Welcome popup",
"display_type": "popup",
"status": "live",
"views": 7400,
"signups": 212,
"signup_rate_percent": 2.9
},
{
"id": "dsp_19a4",
"title": "Exit offer",
"display_type": "popup",
"status": "live",
"views": 6200,
"signups": 31,
"signup_rate_percent": 0.5
},
{
"id": "dsp_88d2",
"title": "Spring flyout",
"display_type": "flyout",
"status": "live",
"views": 3900,
"signups": 27,
"signup_rate_percent": 0.7
}
],
"pagination": {
"page": 1,
"per_page": 25,
"total_count": 3,
"total_pages": 1
}
}