API Reference

The ViewBot API is organized around REST. It provides predictable, resource-oriented URLs, accepts JSON-encoded request bodies, and returns structured JSON responses. Standard HTTP response codes, authentication headers, and verbs are used throughout.

Base URL

https://api.viewbot.tv/api/

You can use the API in test mode to simulate campaigns and verify automation logic without generating live traffic. Your API key determines whether a request operates in test or live mode — test mode requests do not interact with real view networks or connected accounts.

Each request targets a specific resource — such as sessions, views, or campaigns. The API does not support bulk modifications; you can only update one object per request.

The ViewBot API evolves continuously. Endpoints or response fields may vary between accounts depending on your plan, access level, or version. Log in to your dashboard to view documentation personalized with your test key and data.

SDK Libraries

Install and integrate in minutes with your preferred language.

$ pip install your-sdk

Authentication

Each request must include a valid secret key in the header. This ensures all operations are securely linked to your account.

POST/auth

A simple authenticated request using our SDK.

Update a User

Use this endpoint to modify an existing user’s information.

PUT/users/:id

Update a user’s name, email, or other fields.

Parameters

When updating a user, you can provide the following parameters in the request body:

nameRequired(string)

The user's full name. Must be at least 2 characters long.

emailRequired(string)

The user's email address. Must be unique and properly formatted.

bio(string)

Optional short biography to display on the user's profile.

avatar_url(string)

Optional URL to the user's profile image.

Errors & Status Codes

The API returns structured error responses to help you diagnose issues quickly. Errors include a category, a readable message, and an associated HTTP status code.

Error Attributes

type

Short identifier describing the error category (e.g. invalid_request, authentication_error).

message

Human-readable explanation of what went wrong.

param

(Optional) Field related to the error, when applicable.

status

HTTP status code associated with the error.

Error Types

invalid_request

Malformed request, missing parameters, or unsupported fields.

authentication_error

Missing, invalid, or expired API key.

rate_limit_error

Too many requests were made too quickly.

server_error

Unexpected error occurred on our side. Retry your request.

HTTP Status Code Summary

200
OK
Everything worked as expected.
400
Bad Request
Malformed or missing parameters.
401
Unauthorized
Invalid or missing API key.
403
Forbidden
You do not have permission to perform this action.
404
Not Found
The requested resource does not exist.
409
Conflict
The request conflicts with another operation.
429
Too Many Requests
Rate limit exceeded. Slow down and retry.
500–504
Server Errors
Unexpected server-side error occurred.