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

Vanilla Forums Analytics API

The Analytics API from Vanilla Forums — 10 operation(s) for analytics.

Vanilla Forums Analytics API is one of 57 APIs that Vanilla Forums publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Analytics. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 13 operations across 10 paths, and defines 37 schemas. It is described by OpenAPI 3.2.0, at version 2.0.

Requests are made against a single base URL, https://open.vanillaforums.com/api/v2.

13 operations 10 paths 37 schemas 1 DELETE7 GET1 PATCH4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Base URL
https://open.vanillaforums.com/api/v2
Resource Areas
1

Paths & Operations 13

Across 10 paths, the API surfaces 13 operations — 1 DELETE, 7 GET, 1 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Analytics 13
POST
/analytics/analysis
Get the results of an analytics query
postAnalyticsAnalysis body → 201400
GET
/analytics/catalog
Get analytics catalog
getAnalyticsCatalog 1 param → 200401
GET
/analytics/catalog/data-sources
Get analytics catalog data sources
getAnalyticsCatalogDataSources 1 param → 200401
GET
/analytics/catalog/data-sources/{key}
Get analytics catalog data sources by key
getAnalyticsCatalogDataSourcesByKey 2 params → 200401404
GET
/analytics/dashboard-navigation
Get all of the available analytics dashboards
getAnalyticsDashboardNavigation 1 param → 200401
POST
/analytics/dashboards
Add a new dashboard
postAnalyticsDashboards body → 201
GET
/analytics/dashboards
List all dashboards
getAnalyticsDashboards 1 param → 200
GET
/analytics/dashboards/{id}
Get a dashboard
getAnalyticsDashboardsById 2 params → 200401404
PATCH
/analytics/dashboards/{id}
Update an existing dashboard
patchAnalyticsDashboardsById 1 param body → 200401404
DELETE
/analytics/dashboards/{id}
Delete a dashboard
deleteAnalyticsDashboardsById 1 param → 204400401404
POST
/analytics/keen-query/{analysisType}
Get the result of an analytics query
postAnalyticsKeenQueryByAnalysisType 1 param body → 201400
GET
/analytics/leaderboard
Retrieve data for a leaderboard
getAnalyticsLeaderboard 5 params → 200
POST
/analytics/query
Get the result of an analytics query. (legacy)
postAnalyticsQuery body → 201400

Schemas 37

The contract defines 37 schemas that model the data the API accepts and returns. The most detailed are Export (19 properties), Leaderboard (7 properties), AnalyticsDashboardFragment (5 properties), LegacyQueryFilter (4 properties). Each schema is shown below with its type and property counts.

SortDirection
string
The sort direction for ordering results.
TargetProperty
An event property to perform the analysis on. Required for countunique, minimum, maximum, median and sum query types.
AnalyticsExtractCsv
string
CSV data returned when extracting CSV data.
QueryInterval
string
Time interval for grouping results. If your specified interval and date range produce more than 500 intervals, the interval will be automatically bumped up to…
AnalyticsDataSourceFragment
object
Represents a data source that can be queried.
3 properties 2 required
ExportStatus
string
The status of the export.
Leaderboard
object
7 properties 7 required
AnalyticsSingleResult
object
Single numeric result returned when neither grouping nor intervals are specified.
2 properties 2 required
EventCollection
string
Analytics event collection. Different types of events are stored in different collections.
UpdateInfo
object
3 properties
AnalyticsDashboard
An analytics dashboard.
Export
object
19 properties 17 required
LegacyOrderBy
object
Ordering specification for legacy analytics queries.
2 properties
AnalyticsLimit
integer
Maximum number of results to return. Requires at least one group field.
InsertInfo
object
3 properties 3 required
AnalyticsIntervalResult
object
Time-series results returned when interval is specified without groupBy.
1 property 2 required
Timeframe
object
Time range for analytics queries.
2 properties 2 required
FilterOperator
string
The comparison or logical operation for analytics filters.
AnalyticsDashboardFragment
object
Basic information about an analytics dashboard.
5 properties
AnalyticsGroupedIntervalResult
object
Time-series results with grouping returned when both interval and groupBy are specified.
2 properties 2 required
KeenQueryFilter
object
Filter condition for Keen-compatible analytics queries. Supports nested filters using 'and'/'or' operators with operands array, or field filters with propertyn…
4 properties 1 required
AnalysisType
string
Type of analysis to perform on the data.
AnalyticsDataSource
QueryScope
string
Should the query be scoped to the single site or the hub.
BasicError
object
2 properties 2 required
StandardQueryFilter
object
Filter condition for standard analytics queries. Supports nested filters using 'and'/'or' operators with operands array, or field filters with propertyName/ope…
4 properties 1 required
StandardOrderBy
object
Ordering specification for standard analytics queries.
2 properties
ExtractionFields
array
Select specific fields to extract during an extraction query. Wildcard patterns are supported.
AnalyticsExtractJson
array
JSON data returned when extracting JSON data.
KeenOrderBy
object
Ordering specification for Keen-compatible analytics queries.
2 properties
AnalyticsDataSourceProperty
object
Represents a column in a data source.
3 properties 2 required
AnalyticsCatalog
object
Contains meta information about analytics data sources.
1 property 1 required
AnalyticsGroupedResult
object
Array of grouped results returned when groupBy is specified without interval.
2 properties 2 required
LegacyQueryFilter
object
Filter condition for legacy analytics queries. Supports nested filters using 'and'/'or' operators with operands array, or field filters with prop/op/val.
4 properties 1 required
GroupByArray
array
An array of event properties to group results by. When used with interval, only one group field is allowed.
AnalyticsDashboardSection
object
A section that groups similar analytics dashboards together.
2 properties 2 required
ExtractionFormat
string
The format to extract the data in.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vanilla-forums-analytics-api-openapi.yml Raw ↑

Other APIs Vanilla Forums publishes across the network.

Vanilla Forums AI Processing Preferences API
Vanilla Forums AI Settings API
Vanilla Forums Appeals API
Vanilla Forums Assets API
Vanilla Forums Audit Logs API
Vanilla Forums Authenticators API
Vanilla Forums Automation Rules API
Vanilla Forums Calls API
Vanilla Forums Categories API
Vanilla Forums Collections API
Vanilla Forums Comments API
Vanilla Forums Config API
Where this information came from

This is an independent, third-party profile of Vanilla Forums Analytics 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.