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 components
Upload a component module
Submit a component's source
Retrieve a component
Update a component
Delete a component
List a component's versions
Retrieve a component version
Update a component version
List component uses

List component uses

Lists the component versions the project's published paywalls embed, project and registry components alike, with how many published paywalls embed each, so deprecated, deleted or yanked components can be found where they are still live.

Guide: Components

GET
/api/v1/projects/{projectId}/component-uses

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.

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/component-uses" \  -H "Authorization: Bearer vh_sk_..."
{  "data": [    {      "source": "project",      "slug": "plan-picker",      "version": 3,      "contentHash": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",      "publishedPaywallCount": 2    }  ],  "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 Components

  • List components GET
  • Upload a component module POST
  • Submit a component's source POST
  • Retrieve a component GET
  • Update a component PATCH
  • Delete a component DELETE
  • List a component's versions GET
  • Retrieve a component version GET
  • Update a component version PATCH

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

PreviousUpdate a component versionNextRetrieve the registry publisher

On this page

AuthorizationPath parametersQuery parametersExamplesResponse bodyErrorsMore in Components