Jump to

• Request
• Response
• Examples

Retrieve a list of export definitions for an event

get

/api/bulk/2.0/events/{id}/exports

Retrieves the list of export definitions for the event with the specified id.

Request

Supported Media Types

• application/json
• text/csv

Path Parameters

• id: integer

Query Parameters

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : EventExportSearchResponse

Type: object

Title: EventExportSearchResponse

Show Source

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

{
    "title":"EventExportSearchResponse",
    "description":"",
    "properties":{
        "count":{
            "title":"count",
            "description":"",
            "type":"integer"
        },
        "hasMore":{
            "title":"hasMore",
            "description":"",
            "type":"boolean"
        },
        "items":{
            "title":"items",
            "description":"",
            "type":"array",
            "items":{
                "$ref":"#/definitions/Export"
            }
        },
        "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 Export
  Title: Export

{
    "title":"items",
    "description":"",
    "type":"array",
    "items":{
        "$ref":"#/definitions/Export"
    }
}

Nested Schema : Export

Type: object

Title: Export

Show Source

• areSystemTimestampsInUTC(optional): boolean
  Title: areSystemTimestampsInUTC
• autoDeleteDuration(optional): string
  Title: autoDeleteDuration
• createdAt(optional): string(date-time)
  Title: createdAt
• createdBy(optional): string
  Title: createdBy
• crmAccountIdField(optional): string
  Title: crmAccountIdField
• dataRetentionDuration(optional): string
  Title: dataRetentionDuration
• externalSystemId(optional): integer
  Title: externalSystemId
• fields(optional): object fields
  Title: fields
• filter(optional): string
  Title: filter
• incremental(optional): boolean
  Title: incremental
• incrementalEndDate(optional): string
  Title: incrementalEndDate
• incrementalStartDate(optional): string
  Title: incrementalStartDate
• kbUsed(optional): integer(int64)
  Title: kbUsed
• lastSavedId(optional): integer(int64)
  Title: lastSavedId
• maxRecords(optional): integer
  Title: maxRecords
• name(optional): string
  Title: name
• syncActions(optional): array syncActions
  Title: syncActions
• updatedAt(optional): string(date-time)
  Title: updatedAt
• updatedBy(optional): string
  Title: updatedBy
• uri(optional): string
  Title: uri

{
    "title":"Export",
    "description":"",
    "properties":{
        "areSystemTimestampsInUTC":{
            "title":"areSystemTimestampsInUTC",
            "description":"",
            "type":"boolean"
        },
        "autoDeleteDuration":{
            "title":"autoDeleteDuration",
            "description":"",
            "type":"string"
        },
        "createdAt":{
            "format":"date-time",
            "title":"createdAt",
            "description":"",
            "type":"string"
        },
        "createdBy":{
            "title":"createdBy",
            "description":"",
            "type":"string"
        },
        "crmAccountIdField":{
            "title":"crmAccountIdField",
            "description":"",
            "type":"string"
        },
        "dataRetentionDuration":{
            "title":"dataRetentionDuration",
            "description":"",
            "type":"string"
        },
        "externalSystemId":{
            "title":"externalSystemId",
            "description":"",
            "type":"integer"
        },
        "fields":{
            "title":"fields",
            "description":"",
            "type":"object"
        },
        "filter":{
            "title":"filter",
            "description":"",
            "type":"string"
        },
        "incremental":{
            "title":"incremental",
            "description":"",
            "type":"boolean"
        },
        "incrementalEndDate":{
            "title":"incrementalEndDate",
            "description":"",
            "type":"string"
        },
        "incrementalStartDate":{
            "title":"incrementalStartDate",
            "description":"",
            "type":"string"
        },
        "kbUsed":{
            "format":"int64",
            "title":"kbUsed",
            "description":"",
            "type":"integer"
        },
        "lastSavedId":{
            "format":"int64",
            "title":"lastSavedId",
            "description":"",
            "type":"integer"
        },
        "maxRecords":{
            "title":"maxRecords",
            "description":"",
            "type":"integer"
        },
        "name":{
            "title":"name",
            "description":"",
            "type":"string"
        },
        "syncActions":{
            "title":"syncActions",
            "description":"",
            "type":"array",
            "items":{
                "$ref":"#/definitions/SyncAction"
            }
        },
        "updatedAt":{
            "format":"date-time",
            "title":"updatedAt",
            "description":"",
            "type":"string"
        },
        "updatedBy":{
            "title":"updatedBy",
            "description":"",
            "type":"string"
        },
        "uri":{
            "title":"uri",
            "description":"",
            "type":"string"
        }
    }
}

Nested Schema : fields

Type: object

Title: fields

Nested Schema : syncActions

Type: array

Title: syncActions

Show Source

• Array of: object SyncAction
  Title: SyncAction

{
    "title":"syncActions",
    "description":"",
    "type":"array",
    "items":{
        "$ref":"#/definitions/SyncAction"
    }
}

Nested Schema : SyncAction

Type: object

Title: SyncAction

Show Source

• action(optional): string
  Title: SyncActionType

  Default Value: add

  Allowed Values: [ "add", "remove", "setStatus" ]
• destination(optional): string
  Title: destination
• status(optional): string
  Title: MemberStatus

  Default Value: bounced

  Allowed Values: [ "bounced", "subscribed", "unsubscribed", "active", "complete", "pending", "errored", "yes", "no", "invalid", "permission" ]
• updateAll(optional): boolean
  Title: updateAll

{
    "title":"SyncAction",
    "description":"",
    "properties":{
        "action":{
            "$ref":"#/definitions/SyncActionType"
        },
        "destination":{
            "title":"destination",
            "description":"",
            "type":"string"
        },
        "status":{
            "$ref":"#/definitions/MemberStatus"
        },
        "updateAll":{
            "title":"updateAll",
            "description":"",
            "type":"boolean"
        }
    }
}

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

Retrieve the event export definitions for the event with id#5:

GET /events/5/exports
			

Response:

{
    "count": 1,
    "hasMore": false,
    "items": [
        {
            "createdAt": "2014-08-12T18:30:46.5070000Z",
            "createdBy": "API.User",
            "fields": {
                "ID": "{{Event[5].Field[70]}}",
                "email": "{{Event[5].Field[73]}}",
                "name": "{{Event[5].Field[74]}}"
            },
            "name": "Example Event Export",
            "syncActions": [],
            "updatedAt": "2014-08-12T18:30:46.5070000Z",
            "updatedBy": "API.User",
            "uri": "/events/5/exports/189"
        }
    ],
    "limit": 1000,
    "offset": 0,
    "totalResults": 1
}
			

Back to Top