Skip to navigation
aVenture APICompaniesEntity Research

Get Research Detail

View as Markdown
Returns one research detail for an entity.

Authentication

AuthorizationBearer

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

Path parameters

entityIdstringRequiredformat: "uuid"

Entity id (UUID).

detailIdintegerRequired
Research detail id.

Response headers

ETagstringOptional

Strong research detail revision for If-Match.

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
entityIdstringformat: "uuid"

Entity id (UUID)

idinteger
typeResearchDetailstring
valueTypeenum
Kind of value a research detail holds
Allowed values:
asOfDatestring or nullOptionalformat: "^(?!0000)[0-9]{4}(?:-(?:0[1-9]|1[0-2])(?:-(?:0[1-9]|[12][0-9]|3[01])(?:T(?:[01][0-9]|2[0-3]):[0-5][0-9](?::[0-5][0-9](?:\.[0-9]{1,9})?)?(?:Z|[+-](?:(?:0[0-9]|1[0-7]):[0-5][0-9]|18:00)))?)?)?$"
Date the research detail applies to, preserving the source's calendar or timestamp precision.
currentEligibleboolean or nullOptionalRead-only

Eligibility as a current fact at response time; multiple rows may be eligible. Select the first eligible row in the returned authoritative order.

decimalValuestring or nullOptional

Exact monetary amount as a plain decimal string. Absent on legacy Double-only facts; never reconstruct exactness from discreteValue.

derivedRangeobject or nullOptionalRead-only

Read-only range derived only for targetDateAbsolute detail rows

discreteValuedouble or nullOptional
measurementBasisstring or nullOptional

Source-stated measurement/accounting basis; null means unknown.

publicSourceobject or nullOptional

Published page behind this value, read from the provenance event that wrote it; absent for internal sources.

reportingScopestring or nullOptional

Source-stated reporting scope; null means unknown.

textValuestring or nullOptional
updatedAtdatetime or nullOptional
valueResearchDetailstring or nullOptional

Errors

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