Speeda Ranking — Data Models

Paginated Response

All list endpoints return a common paginated response envelope.

Field	Type	Nullable	Description
data	array	No	Array of result objects
page	integer (int32)	No	Current page number (1-indexed)
pageSize	integer (int32)	No	Page size
total	integer (int64)	No	Total number of elements across all pages

---

Company Ranking

Individual company ranking data with engagement metrics. Returned by GET /companies.

Field	Type	Nullable	Description
companyName	string	No	Company name
tickerSymbol	string	Yes	Stock ticker symbol
headquarters	string	No	Headquarters location
totalPageViews	integer (int64)	No	Total page views in the date range
totalUniquePageViews	integer (int64)	No	Total unique page views in the date range
engagementTime	Engagement Time	Yes	Engagement time metrics in minutes. null if no engagement data available

---

Company Page Ranking

Company ranking data with per-page-type breakdown. Returned by GET /company-pages.

Field	Type	Nullable	Description
companyName	string	No	Company name
tickerSymbol	string	Yes	Stock ticker symbol
headquarters	string	No	Headquarters location
totalPageViews	integer (int64)	No	Total page views across all page types
totalUniquePageViews	integer (int64)	No	Total unique page views across all page types
engagementTime	Engagement Time	Yes	Engagement time metrics in minutes. null if no engagement data available
pages	object (map of string → Page Stats Value)	No	Per-page-type breakdown of stats, keyed by page type. A null value indicates zero stats for that page type

Page Types

Possible keys for the pages map:

Key	Description
OVERVIEW	Company overview page
COMPETITOR_OVERVIEW	Competitor overview page
SEGMENT_COMPARISON	Segment comparison page
NEWS	News page
MA	M&A page
SHAREHOLDERS	Shareholders page
EXECUTIVES_CHART	Executives chart page
AFFILIATES	Affiliates page
STOCK_PRICES	Stock prices page
INVESTOR_RELATIONS	Investor relations page
STATS	Stats page
TECHNOLOGY	Technology page
FINANCIAL_RESULTS	Financial results page
SEGMENT	Segment page
KPI_CHARTS	KPI charts page
ESTIMATES	Estimates page
BETA	Beta page
FUNCTIONALITY	Functionality page

---

Page Stats Value

Stats for a specific page type. Used as map values in the pages field.

Field	Type	Nullable	Description
totalPageViews	integer (int64)	No	Total page views for this page type
totalUniquePageViews	integer (int64)	No	Total unique page views for this page type
engagementTime	Engagement Time	Yes	Engagement time metrics in minutes. null if no engagement data available

---

Industry Ranking

Individual industry ranking data with engagement metrics. Returned by GET /industries.

Field	Type	Nullable	Description
industryId	string	No	Industry ID
industryName	string	No	Industry name
industryDescription	string	No	Industry description
sectorName	string	No	Sector name
subSectorName	string	No	Subsector name
totalPageViews	integer (int64)	No	Total page views in the date range
totalUniquePageViews	integer (int64)	No	Total unique page views in the date range

---

Engagement Time

Engagement time metrics in minutes.

Field	Type	Nullable	Description
avg	number (double)	No	Average engagement time in minutes
min	number (double)	Yes	Minimum engagement time in minutes
max	number (double)	Yes	Maximum engagement time in minutes

---

Error Response

Field	Type	Nullable	Description
error	Error Details	No	Error detail object

---

Error Details

Field	Type	Nullable	Description
code	string	No	Machine-readable error code
message	string	No	Human-readable error message
traceId	string	Yes	Trace ID for support escalation
details	Validation Detail[]	Yes	Array of field-level validation errors

---

Validation Detail

Field	Type	Nullable	Description
field	string	No	The field that failed validation
issue	string	No	Description of the validation issue