Skip to main content
GET
Retrieve Head To Head

Authorizations

X-Lightsage-Api-Key
string
header
required

Query Parameters

limit
integer
default:500

Most recent attempts to include in the records.

Required range: 1 <= x <= 500

Response

Successful Response

company
V2AgentPreferenceCompany · object
required

Your company, the side every record is counted from.

summary
V2AgentPreferenceRecord · object
required

Combined record across every competitor.

count
integer
required

The number of items in data.

attempts_considered
integer
required

Recent attempts read to build the records. Attempts without a usable recommendation are read but not counted as comparisons.

limit
integer
required
truncated
boolean
required

True when older attempts exist beyond limit and were not counted.

data
V2AgentPreferenceMatchup · object[]

One record per competitor, most comparisons first.