List Research Details

GET

https://api.aventure.vc/v1/entities/:entityId/research-details

GET

/v1/entities/:entityId/research-details

curl -G https://api.aventure.vc/v1/entities/04e2bf9c-a100-72ad-83ff-ba69c647b30b/research-details \
     -H "Authorization: Bearer <token>" \
     -d page=0 \
     -d size=25 \
     -d type=nameCongruencyScore

{
  "content": [
    {
      "entityId": "string",
      "id": 1,
      "typeResearchDetail": "string",
      "valueType": "text",
      "asOfDate": "string",
      "currentEligible": true,
      "decimalValue": "string",
      "derivedRange": {
        "asOfDate": "string",
        "bucket": "pastDue",
        "monthsFromNow": 1,
        "targetDate": "2024-01-15T09:30:00Z"
      },
      "discreteValue": 1.1,
      "measurementBasis": "string",
      "publicSource": {
        "recordedAt": "2024-01-15T09:30:00Z",
        "sourceDetail": "string",
        "lastFetchedAt": "2024-01-15T09:30:00Z",
        "publishedAt": "2024-01-15T09:30:00Z"
      },
      "reportingScope": "string",
      "textValue": "string",
      "updatedAt": "2024-01-15T09:30:00Z",
      "valueResearchDetail": "string"
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 1,
  "numberOfElements": 1,
  "pageable": {
    "offset": 1,
    "pageNumber": 1,
    "pageSize": 1,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 1,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 1,
  "totalPages": 1
}

Returns paginated research details for an entity. Optionally filter by detail type. Rows for timeSeries=true types are history, not stale current state.

Authentication

AuthorizationBearer

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

Path parameters

entityIdstringRequiredformat: "uuid"

Entity id (UUID).

Query parameters

pageintegerOptionalDefaults to 0

Zero-based page index (0..N)

sizeintegerOptionalDefaults to 20

The size of the page to be returned

typestringOptional

Research detail type token. Run GET /v1/entities/research-details/types (CLI: entities research-details types list) for the token inventory and each token’s value shape.

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

contentlist of objectsOptional

emptybooleanOptional

firstbooleanOptional

lastbooleanOptional

numberintegerOptional

numberOfElementsintegerOptional

pageableobjectOptional

sizeintegerOptional

sortobjectOptional

totalElementslongOptional

totalPagesintegerOptional

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