VoidhashDocs
DevelopersHelp centerGuidesAPI reference
Dashboard
Essentials
API overview
Authentication
Event capture
Push device API
Webhooks
Webhook delivery
Webhook events
Projects & keys
Projects
API keys
Audit log
Customers & access
Persons
Products
Perks
Sandbox
Paywalls
Paywalls
Paywall locations
Components
Component registry
Assets
Experiments & flags
Experiments
Feature flags
Analytics & events
Analytics
Analytics alerts
Events
Ingest policy
VoidQL
Tracking domains
Ads
Ads
Ad accounts
Meta measurement
Payments & stores
Payment providers
Payment provider products
Purchase history imports
Payment sources
Webhooks & notifications
Webhooks
Push notifications
Push configurations
Automations
Organization & team
Organizations
Members
Invitations
Billing
Your account
Profile
Session
Notices
Connected apps
Terms of Service
Developer tools
Schema
SDK
List paywall locations
Create a paywall location
Retrieve a paywall location
Update a paywall location
Archive a paywall location
Place a paywall at a location
End a location's placement
List what a location has shown

List what a location has shown

Lists what the location has shown, most recently started first: one entry for each paywall build or experiment it showed, and when.

The current one, if any, has a null endedAt.

Guide: Paywalls in your app

GET
/api/v1/projects/{projectId}/paywall-locations/{paywallLocationId}/showings

Authorization

AuthorizationBearer <token>

A project secret key: vh_sk_... for production, vh_sk_test_... for test. Keep it on your servers.

In: header

Path parameters

projectId*string

The project's id, proj_.... A secret key works only in the project it belongs to.

paywallLocationId*string

The location's id, pw_loc_....

Query parameters

cursor?string

Where the page starts: the pageInfo.endCursor of the previous page. Omit it for the first page.

limit?integer

How many items to return, from 1 to 100. Defaults to 50.

Range1 <= value <= 100

Examples

curl -X GET "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/paywall-locations/pw_loc_e2r5t8y1u4i7o0p3a6s9d2f5/showings" \  -H "Authorization: Bearer vh_sk_..."
{  "data": [    {      "id": "pw_loc_show_w4e8r2t6y0u3i7o1p5a9s3d7",      "paywallLocationId": "pw_loc_e2r5t8y1u4i7o0p3a6s9d2f5",      "type": "paywall",      "paywallId": "pw_h7d2k9m4x1c6v8b3n5q0w2e7",      "buildNumber": 3,      "featureFlagId": null,      "startedAt": "2026-03-10T11:05:02.000Z",      "endedAt": null,      "createdByUserId": "user_k3m8q1z6v9c2x5b7n4w0e8r1"    },    {      "id": "pw_loc_show_t6y0u3i7o1p5a9s3d7w4e8r2",      "paywallLocationId": "pw_loc_e2r5t8y1u4i7o0p3a6s9d2f5",      "type": "paywall",      "paywallId": "pw_r3t6y9u2i5o8p1a4s7d0f3g6",      "buildNumber": 5,      "featureFlagId": null,      "startedAt": "2026-02-21T08:00:00.000Z",      "endedAt": "2026-03-10T11:05:02.000Z",      "createdByUserId": "user_k3m8q1z6v9c2x5b7n4w0e8r1"    }  ],  "pageInfo": {    "endCursor": null,    "hasNextPage": false  }}
{  "error": {    "type": "invalid_request",    "code": "invalid_query",    "message": "The request query is invalid: Expected a finite number\n  at [\"limit\"]"  }}
{  "error": {    "type": "unauthenticated",    "code": "invalid_api_key",    "message": "This secret key is not valid."  }}
{  "error": {    "type": "permission_denied",    "code": "permission_denied",    "message": "Insufficient permissions."  }}
{  "error": {    "type": "not_found",    "code": "project_not_found",    "message": "There is no project proj_tz4a98xxat96iws9zmbrgj3a, or this credential cannot use it.",    "param": "projectId"  }}
{  "error": {    "type": "internal",    "code": "internal_error",    "message": "Something went wrong on our side. Try again, and contact support with the Request-Id header if it keeps failing."  }}

Response body

application/json

application/json

application/json

application/json

application/json

application/json

Errors

This operation adds no error codes of its own. It can fail with the errors every operation shares, such as unauthenticated; see Errors.

More in Paywall locations

  • List paywall locations GET
  • Create a paywall location POST
  • Retrieve a paywall location GET
  • Update a paywall location PATCH
  • Archive a paywall location POST
  • Place a paywall at a location PUT
  • End a location's placement DELETE

Something wrong or missing on this page? Tell us by email or on Discord.

PreviousEnd a location's placementNextList components

On this page

AuthorizationPath parametersQuery parametersExamplesResponse bodyErrorsMore in Paywall locations