Sample Records | Polytomic Docs

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

AuthorizationBearer

Bearer user API key

AuthorizationBasic

Basic organization-scoped API key

Path parameters

idstringRequiredformat: "uuid"

Query parameters

asyncbooleanOptional

Response

dataobject

jobobject

Errors

400

Bad Request Error

404

Not Found Error

500

Internal Server Error

1	{
2	"data": {
3	"records": [
4	{
5	"enricher-uuid": {
6	"name": "James"
7	},
8	"model-uuid": {
9	"name": "Jim"
10	}
11	}
12	],
13	"warnings": [
14	"Enrichment failed for 4 records: you have ran out of credits"
15	]
16	},
17	"job": {
18	"error": "error message",
19	"job_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
20	"status": "created",
21	"type": "createmodel"
22	}
23	}

1	curl https://app.polytomic.com/api/models/248df4b7-aa70-47b8-a036-33ac447e668d/sample \
2	-H "X-Polytomic-Version: X-Polytomic-Version" \
3	-H "Authorization: Bearer <token>"

Authentication

Path parameters

Headers

Query parameters

Response

Errors