...
Before sending the request, make sure to whitelist your IP through which you are sending API request in the whitelist section.
Request Parameters:
Method |
|
|---|
|
| ||
Body | JSON | |
|---|---|---|
Headers | Content-Type: application/json | |
Auth | None | |
URL | Please contact your Customer Success Manager for the URL |
Request Payload:
| Code Block |
|---|
{
"phonon-uuids": [
{"<36 character alphanumeric Phonon UUID>"},
{"<36 character alphanumeric Phonon UUID>"},
...
],
"fetch-attempt": "ALL" // ALL = Fetch all attempts; LAST = Fetch only last attempt
} |
...
| Code Block | ||
|---|---|---|
| ||
{
"phonon-uuids": [
"b2f9909e-9ac4-4e5c-9ac8-183f24ea9436"
],
"fetch-attempt": "ALL"
} |
The Pull API has now been updated to take additional parameters in the Request Payload in the new version of the Pull API URL. This is done to ensure an additional layer of authentication or security step.
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
Please contact your Customer Success Manager for the updated URL. |
Pull API Version 2.0
Request Payload:
| Code Block |
|---|
{
"security-id": "<64 character alphanumeric Security ID>",
"flow-id": "<8 character alphanumeric Flow ID>",
"phonon-uuids": [
{"<36 character alphanumeric Phonon UUID>"},
{"<36 character alphanumeric Phonon UUID>"},
...
],
"fetch-attempt": "ALL" // ALL = Fetch all attempts; LAST = Fetch only last attempt
} |
Sample Request:
| Code Block | ||
|---|---|---|
| ||
{ "security-id": "437457061e066a3f5c6520cba6fc920965a3d84386d863610dcad56d39699999", "flow-id": "iH5Gzxxx", "phonon-uuids": [ "019060e2-2788-4b5a-a87f-c1508ee29999", "1591df5e-d434-4921-923e-32e04b8b9999" ], "fetch-attempt": "ALL" } |
Notes:
Ensure valid JSON format
Ensure IP is Whitelisted in your account
Ensure your account validity is not expired
Ensure number of Phonon UUIDs is less than Max data size (
...
200 UUIDs is current max limit) - Response will contain api-response-message as ‘Max Data List Size Exceeded’ and no result will be fetched.
...
Response Parameters:
If there’s no data available:
...