How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Paid Custom Views Experimental API

The customViewsExperimental API from Paid — 6 operation(s) for customviewsexperimental.

Paid Custom Views Experimental API is one of 22 APIs that Paid publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 8 operations across 6 paths, and defines 33 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://api.agentpaid.io/api/v2.

8 operations 6 paths 33 schemas 4 GET2 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.agentpaid.io/api/v2
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Paid Custom Views Experimental API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth).

  • bearerAuth — API Key authentication using Bearer token

Paths & Operations 8

Across 6 paths, the API surfaces 8 operations — 4 GET, 2 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

customViewsExperimental 8
GET
/experimental/views/
List custom views (experimental)
list-custom-views 1 param → 200403500
POST
/experimental/views/
Create a custom view (experimental)
create-custom-view 1 param body → 201400403500
POST
/experimental/views/{displayId}/publish
Publish a custom view (experimental)
publish-custom-view 2 params body → 200403404500
PATCH
/experimental/views/{displayId}/period
Change a custom view's date range (experimental)
update-custom-view-period 2 params body → 200400403404500
GET
/experimental/views/{displayId}
Get a custom view's metadata + render bundle (experimental)
get-custom-view 2 params → 200403404500
PATCH
/experimental/views/{displayId}
Update a custom view (experimental)
update-custom-view 2 params body → 200400403404500
GET
/experimental/views/{displayId}/data
Fetch a custom view's data, scoped to a customer or the organization…
get-custom-view-data 8 params → 200400403404408429500
GET
/experimental/views/{displayId}/embed-token
Get an embed token for a custom view
get-custom-view-embed-token 4 params → 200400403404500

Schemas 33

The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are CustomViewSummary (8 properties), CustomViewDetail (8 properties), UpdateCustomViewRequest (7 properties), CreateCustomViewRequest (6 properties). Each schema is shown below with its type and property counts.

CustomViewSummary
object
8 properties 8 required
CreateCustomViewRequestScope
string
'customer' (default): data is scoped to one viewing customer and the view is embeddable per-customer. 'organization': data is org-wide; the view is internal-on…
CustomViewDetailStatus
string
CustomViewDetailPeriod
object
The view's current default date range, or null if it uses no adjustable period.
5 properties 1 required
CreateCustomViewRequestPeriodUnit
string
relative only: the unit of the rolling window.
ExperimentalViewsDisplayIdDataGetParametersPeriodKind
string
CustomViewSummaryPeriodUnit
string
relative only: the unit of the rolling window.
ViewDataResponse
object
1 property 1 required
CustomViewSummaryPeriodKind
string
'relative' = a rolling window ending today (set unit + amount); 'absolute' = a fixed calendar range (set start + end).
RenderBundleEdit
object
3 properties 2 required
CustomViewSummaryScope
string
'customer': data is scoped to one viewing customer and the view is embeddable per-customer. 'organization': data is org-wide and the view is internal-only.
UpdateCustomViewPeriodRequest
object
1 property 1 required
CustomViewEmbedTokenResponse
object
2 properties 2 required
UpdateCustomViewRequest
object
7 properties
CreateCustomViewRequest
object
6 properties 3 required
CustomViewStatus
string
A view is DRAFT until explicitly published. For customer-scoped views, only PUBLISHED views are embeddable and served to end-customers; a DRAFT is not. For org…
CustomViewDetailPeriodKind
string
'relative' = a rolling window ending today (set unit + amount); 'absolute' = a fixed calendar range (set start + end).
CustomView
object
5 properties 5 required
UpdateCustomViewPeriodRequestPeriod
object
Default date range for the view's queries. Use {periodstart:DateTime} / {periodend:DateTime} placeholders in your SQL to make the range adjustable. Either rela…
5 properties 1 required
CreateCustomViewRequestPeriodKind
string
'relative' = a rolling window ending today (set unit + amount); 'absolute' = a fixed calendar range (set start + end).
CustomViewDetail
object
8 properties 8 required
ExperimentalViewsDisplayIdDataGetParametersPeriodUnit
string
CreateCustomViewRequestPeriod
object
Optional default date range. Required if any query uses the {periodstart:DateTime} / {periodend:DateTime} placeholders. Can be changed later in Paid without re…
5 properties 1 required
CustomViewSummaryPeriod
object
The view's default date range, or null if it has none.
5 properties 1 required
CustomViewDetailPeriodUnit
string
relative only: the unit of the rolling window.
UpdateCustomViewPeriodRequestPeriodKind
string
'relative' = a rolling window ending today (set unit + amount); 'absolute' = a fixed calendar range (set start + end).
CustomViewListResponse
object
1 property 1 required
CustomViewDetailScope
string
'customer': data is scoped to one viewing customer and the view is embeddable per-customer. 'organization': data is org-wide and the view is internal-only.
CustomViewQuery
object
2 properties 2 required
CustomViewSummaryStatus
string
UpdateCustomViewPeriodRequestPeriodUnit
string
relative only: the unit of the rolling window.
ErrorResponse
object
3 properties 1 required
CustomViewScope
string
'customer': data is scoped to one viewing customer and the view is embeddable per-customer. 'organization': data is org-wide and the view is internal-only.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

paid-customviewsexperimental-api-openapi.yml Raw ↑

Other APIs Paid publishes across the network.

Paid Agents API
Paid Analytics Experimental API
Paid Checkouts API
Paid Contacts API
Paid Costs API
Paid Credits API
Paid Customer Groups API
Paid Customer Portals API
Paid Customers API
Paid Invoices API
Paid Orders API
Paid orders > lines API
Where this information came from

This is an independent, third-party profile of Paid Custom Views Experimental API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.