Jump to

• Request
• Response
• Examples

Retrieve an export sync's data

get

/api/bulk/2.0/syncs/{id}/data

Retrieves an export sync's data. This endpoint allows you to retrieve data from an export that you have sync'd more than once. This endpoint will not return any information for import syncs: if the specified sync is an import Eloqua will return a 400 HTTP error code.

Request

Supported Media Types

• application/json
• text/csv

Path Parameters

• id(required): integer

Query Parameters

• limit: integer
• links: string
• offset: integer
• totalResults: boolean

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : SyncDataQueryResponse

Type: object

Title: SyncDataQueryResponse

Show Source

• count: integer
  Title: count
• hasMore: boolean
  Title: hasMore
• items: array items
  Title: items
• limit: integer
  Title: limit
• offset: integer
  Title: offset
• totalResults: integer(int64)
  Title: totalResults

{
    "title":"SyncDataQueryResponse",
    "description":"",
    "properties":{
        "count":{
            "title":"count",
            "description":"",
            "type":"integer"
        },
        "hasMore":{
            "title":"hasMore",
            "description":"",
            "type":"boolean"
        },
        "items":{
            "title":"items",
            "description":"",
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "limit":{
            "title":"limit",
            "description":"",
            "type":"integer"
        },
        "offset":{
            "title":"offset",
            "description":"",
            "type":"integer"
        },
        "totalResults":{
            "format":"int64",
            "title":"totalResults",
            "description":"",
            "type":"integer"
        }
    }
}

Nested Schema : items

Type: array

Title: items

Show Source

• Array of: object items

{
    "title":"items",
    "description":"",
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

400 Response

Bad request. See Status Codes for information about other possible HTTP status codes.

401 Response

Unauthorized. See Status Codes for information about other possible HTTP status codes.

403 Response

Forbidden. See Status Codes for information about other possible HTTP status codes.

404 Response

The requested resource was not found. See Status Codes for information about other possible HTTP status codes.

409 Response

There was a conflict. See Status Codes for information about other possible HTTP status codes.

410 Response

The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes.

412 Response

The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes.

413 Response

Storage space exceeded. See Status Codes for information about other possible HTTP status codes.

500 Response

The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes.

503 Response

There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes.

Back to Top

Examples

The following examples demonstrate how to retrieve a sync using an HTTP request and cURL. For more information on requests, see API requests.

HTTP Request Example

Retrieve the sync with ID = 1444:

GET /syncs/1444/data?limit=2
			

Response:

{
	"totalResults": 10,
	"limit": 2,
	"offset": 0,
	"count": 0,
	"hasMore": true,
	"items": [
		{
			"ID": "123456789 ([e-mail])",
			"email": "[e-mail]",
			"name": "Zafar Manal"
		},
		{
			"ID": "789456123 ([e-mail])",
			"email": "[e-mail]",
			"name": "Joana Mendes"
		}
	]
}
			

cURL Example

Here is the same example in cURL given an instance with the name APITest, username API.User, and POD of 3.

curl --user "APITest\API.User" --request GET https://secure.p03.eloqua.com/api/bulk/2.0/syncs/1444/data?limit=2
			

Back to Top