Deliver results

This endpoint is deprecated. If you wish you trigger a read (including backfills), use the trigger a read endpoint instead.

POST /projects/{projectIdOrName}/integrations/{integrationId}/objects/{objectName}:deliverResults

Deliver results

cURL

curl --request POST \
  --url https://read.withampersand.com/v1/projects/{projectIdOrName}/integrations/{integrationId}/objects/{objectName}:deliverResults \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "groupRef": "<string>",
  "pages": 1
}
'

400

{
  "type": "urn:problem-type:exampleOrganization:exampleProblem",
  "href": "https://www.belgif.be/specification/rest/api-guide/#standardized-problem-types",
  "title": "Description of the type of problem that occurred",
  "status": 400,
  "detail": "Description of specific occurrence of the problem",
  "instance": "urn:uuid:123e4567-e89b-12d3-a456-426614174000"
}

Authorizations

X-Api-Key · string · header · required

Path Parameters

projectIdOrName · string · required

integrationId · string · required

objectName · string · required

Body

application/json

ResultDeliveryRequestBody

groupRef · string · required

The ID of the user group whose SaaS instance you'd like to receive results from. This is the ID that was provided during installation creation.

pages · integer · required

The number of pages you are ready to receive from the group's SaaS instance.

Required range: x >= 0

Response

204

The success response