Skip to navigation
API ReferenceModels

Sample Records

Returns a sample of records from a model.

Synchronous requests must complete within 10 seconds. If the source query or enrichment step can exceed that budget, use the asynchronous option so the work runs as a background job.

Authentication

AuthorizationBasic

This is the Polytomic deployment key (on-premises only)

OR
AuthorizationBearer
This is the Polytomic API key

Path parameters

idstringRequiredformat: "uuid"
Model ID

Headers

X-Polytomic-VersionstringRequired

Query parameters

asyncbooleanOptional
Run in the background and return a job instead of the result.

Response

OK
dataobjectOptional
The sampled records
jobobjectOptional
Background job running the request when async is true

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
500
Internal Server Error