Skip to navigation

List the Accepted Research Detail Types

View as Markdown

Returns each research detail type and the rules for writing a value of that type. The rules include valueShape, allowedToken, range, and timeSeries. When timeSeries=true, each believable dated observation is historical data: add a new current row and delete only rows believed false.

Authentication

AuthorizationBearer

Your aVenture API key (https://aventure.vc/settings/api-keys) or OAuth access token

Response headers

X-RateLimit-LimitintegerOptional

Requests allowed per client IP in the current rate-limit window.

X-RateLimit-RemainingintegerOptional

Requests left before the tightest applicable rate-limit bucket rejects.

X-RateLimit-ResetintegerOptional

Seconds until the exhausted rate-limit bucket admits another request; 0 when none is exhausted.

Response

OK
curatedboolean
labelstring
targetPathstring
timeSeriesboolean

Whether rows are dated history; true means add current observations and keep believable old rows.

typeValuestring
valueShapeenum

Write-time value shape token. For numericCountOrRange details, send either discreteValue for an exact count or textValue for an employee range.

valueTypeenum

Value kind on reads; pick write fields from valueShape.

Allowed values:
writeHintstring

How to encode a write for this valueShape: which of valueResearchDetail, discreteValue, textValue, and asOfDate to send, with an example.

allowedTokenlist of strings or nullOptional
Allowed valueResearchDetail tokens, or textValue categories when valueShape is freeText.
appliesToTypelist of enums or nullOptional

Effective concrete entity kinds for this detail, including inherited section applicability; absent only on older servers. Path prefixes do not override this leaf rule.

rangeobject or nullOptional

Inclusive numeric bounds for monetary and numericRatio, numericScore, and numericGrowthRate values. numericGrowthRate uses percentage points: 80 means 80%, not 0.8.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
406
Not Acceptable Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error