Get an operation

curl --request GET \
  --url https://api.withampersand.com/v1/projects/{projectIdOrName}/operations/{operationId} \
  --header 'X-Api-Key: <api-key>'

import requests

url = "https://api.withampersand.com/v1/projects/{projectIdOrName}/operations/{operationId}"

headers = {"X-Api-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};

fetch('https://api.withampersand.com/v1/projects/{projectIdOrName}/operations/{operationId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.withampersand.com/v1/projects/{projectIdOrName}/operations/{operationId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.withampersand.com/v1/projects/{projectIdOrName}/operations/{operationId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.withampersand.com/v1/projects/{projectIdOrName}/operations/{operationId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "projectId": "project-456",
  "integrationId": "<string>",
  "configId": "config-123",
  "actionType": "read",
  "id": "<string>",
  "installationId": "<string>",
  "status": "success",
  "result": "[contact] No new data found",
  "metadata": {
    "objects": [
      "contact"
    ],
    "progress": {
      "installationId": "66438162-5299-4669-a41d-85c5a3b1a83e",
      "objectName": "contact",
      "operationId": "3efc0f0f-4bb9-498f-996c-9893d98ca4b5",
      "recordsProcessed": 1250,
      "recordsEstimatedTotal": 5000
    }
  },
  "createTime": "2023-07-13T21:34:44.816354Z"
}

{
  "type": "about:blank",
  "href": "https://www.belgif.be/specification/rest/api-guide/#standardized-problem-types",
  "title": "Bad Request",
  "status": 400,
  "detail": "The input message is incorrect",
  "instance": "123456-1234-1235-4567489798",
  "issues": [
    {
      "type": "about:blank",
      "detail": "exampleNumericProperty should be numeric",
      "in": "path",
      "name": "exampleNumericProperty",
      "value": "abc"
    },
    {
      "type": "about:blank",
      "title": "Input isn't valid with respect to schema",
      "detail": "examplePropertyWithPattern a2345678901 doesn't match pattern '^\\d{11}$'",
      "in": "body",
      "name": "items[0].examplePropertyWithPattern",
      "value": "a2345678901"
    }
  ]
}

{
  "type": "about:blank",
  "href": "https://www.belgif.be/specification/rest/api-guide/#standardized-problem-types",
  "title": "Bad Request",
  "status": 400,
  "detail": "The input message is incorrect",
  "instance": "123456-1234-1235-4567489798",
  "issues": [
    {
      "type": "about:blank",
      "detail": "exampleNumericProperty should be numeric",
      "in": "path",
      "name": "exampleNumericProperty",
      "value": "abc"
    },
    {
      "type": "about:blank",
      "title": "Input isn't valid with respect to schema",
      "detail": "examplePropertyWithPattern a2345678901 doesn't match pattern '^\\d{11}$'",
      "in": "body",
      "name": "items[0].examplePropertyWithPattern",
      "value": "a2345678901"
    }
  ]
}

{
  "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"
}

GET

projects

{projectIdOrName}

operations

{operationId}

Get an operation

curl --request GET \
  --url https://api.withampersand.com/v1/projects/{projectIdOrName}/operations/{operationId} \
  --header 'X-Api-Key: <api-key>'

import requests

url = "https://api.withampersand.com/v1/projects/{projectIdOrName}/operations/{operationId}"

headers = {"X-Api-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};

fetch('https://api.withampersand.com/v1/projects/{projectIdOrName}/operations/{operationId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.withampersand.com/v1/projects/{projectIdOrName}/operations/{operationId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.withampersand.com/v1/projects/{projectIdOrName}/operations/{operationId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.withampersand.com/v1/projects/{projectIdOrName}/operations/{operationId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "projectId": "project-456",
  "integrationId": "<string>",
  "configId": "config-123",
  "actionType": "read",
  "id": "<string>",
  "installationId": "<string>",
  "status": "success",
  "result": "[contact] No new data found",
  "metadata": {
    "objects": [
      "contact"
    ],
    "progress": {
      "installationId": "66438162-5299-4669-a41d-85c5a3b1a83e",
      "objectName": "contact",
      "operationId": "3efc0f0f-4bb9-498f-996c-9893d98ca4b5",
      "recordsProcessed": 1250,
      "recordsEstimatedTotal": 5000
    }
  },
  "createTime": "2023-07-13T21:34:44.816354Z"
}

{
  "type": "about:blank",
  "href": "https://www.belgif.be/specification/rest/api-guide/#standardized-problem-types",
  "title": "Bad Request",
  "status": 400,
  "detail": "The input message is incorrect",
  "instance": "123456-1234-1235-4567489798",
  "issues": [
    {
      "type": "about:blank",
      "detail": "exampleNumericProperty should be numeric",
      "in": "path",
      "name": "exampleNumericProperty",
      "value": "abc"
    },
    {
      "type": "about:blank",
      "title": "Input isn't valid with respect to schema",
      "detail": "examplePropertyWithPattern a2345678901 doesn't match pattern '^\\d{11}$'",
      "in": "body",
      "name": "items[0].examplePropertyWithPattern",
      "value": "a2345678901"
    }
  ]
}

{
  "type": "about:blank",
  "href": "https://www.belgif.be/specification/rest/api-guide/#standardized-problem-types",
  "title": "Bad Request",
  "status": 400,
  "detail": "The input message is incorrect",
  "instance": "123456-1234-1235-4567489798",
  "issues": [
    {
      "type": "about:blank",
      "detail": "exampleNumericProperty should be numeric",
      "in": "path",
      "name": "exampleNumericProperty",
      "value": "abc"
    },
    {
      "type": "about:blank",
      "title": "Input isn't valid with respect to schema",
      "detail": "examplePropertyWithPattern a2345678901 doesn't match pattern '^\\d{11}$'",
      "in": "body",
      "name": "items[0].examplePropertyWithPattern",
      "value": "a2345678901"
    }
  ]
}

{
  "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

The Ampersand project ID or project name.

operationId

string

required

Operation ID.

Response

Operation

projectId

string

required

The Ampersand project ID.

Example:

"project-456"

integrationId

string

required

The integration ID.

configId

string

required

The config ID.

Example:

"config-123"

actionType

string

required

The type of action that was performed (read, write, or subscribe).

Example:

"read"

string

required

Unique identifier for this operation. Use this to fetch operation details or list logs for debugging.

installationId

string

required

The Ampersand installation ID (customer instance) that this operation ran for.

status

string

required

The status of the operation.

success: The operation completed successfully
failure: The operation failed
in_progress: The operation is currently running

Example:

"success"

result

string

A human-readable summary of what the operation accomplished. Examples: [contact] No new data found, Batch write completed (3 succeeded, 1 failed). May be absent.

Example:

"[contact] No new data found"

metadata

object

Additional operation details. May include objects (array of object names), retry (retry attempt info), and progress (backfill progress with recordsProcessed, recordsEstimatedTotal) for backfill read operations.

Example:

{
  "objects": ["contact"],
  "progress": {
    "installationId": "66438162-5299-4669-a41d-85c5a3b1a83e",
    "objectName": "contact",
    "operationId": "3efc0f0f-4bb9-498f-996c-9893d98ca4b5",
    "recordsProcessed": 1250,
    "recordsEstimatedTotal": 5000
  }
}

createTime

string<date-time>

The time the operation was created.

Example:

"2023-07-13T21:34:44.816354Z"

Get backfill progress List logs for an operation

⌘I

Introduction

WRITE API

READ API

SEARCH API

PLATFORM API

Get an operation

Authorizations

Path Parameters

Response