Getting Started

Sections

Theme switcher

Validate Subscription (POST)

Header Parameters

api-keystring Required

Your Similarweb Batch API key.

Body Parameters

application_configobject Required

What the subscription runs each time it fires.

Show child attributes

scheduleobject Required

When the subscription runs and how the user is notified.

Show child attributes

subscription_namestring

Human-readable name. Up to 64 chars; letters, digits, '-' and '_' only.

ownerstring

Owner identifier for the subscription (e.g. the email of the responsible person or team). Used for attribution; it is not a notification target.

Response

200 OK
Object

Request is valid.

Response Attributes

is_validboolean

True when the request is valid.

400 Bad Request
Object

Request is invalid.

Response Attributes

is_validboolean

False when invalid.

applicative_errorsarray

Validation errors.

Show child attributes

applicative_warningsarray

Non-blocking warnings.

Was this section helpful?

POST

/

Select
1

Response

Was this section helpful?
View as Markdown

Ask an AI

Open in ChatGPTOpen in ClaudeOpen in Perplexity

Code with AI

Open in Copilot