Log Delivery Service API v1 Data

This section provides details on the various data structures the Log Delivery Service API exchanges.

Configuration

Member Type Description
Required
acgObject Object Configuration acgObject, contains id, name, and type (with possible values CP_CODE, EDNS, or GTM_PROPERTY).
aggregationType Enumeration Type of aggregation value, either COLLECTION or CALENDAR.
configurationType Enumeration Type of configuration, either SPIN, SHADOW, or PRIMARY.
contact Object Contact person information, including a list of email addresses (contactEmail) and Contact identifier (dictId).
deliveryType Enumeration Type of log delivery method, either EMAIL or FTP.
encoding Object Logs encoding value. Contains ID (dictId) from the encoding dictionary. Possible values differ based on the deliveryType. For specific validation context, refer to dictionary validations.
logFormat Object Configuration log format. Contains ID (dictId) from log format dictionary.
logIdentifier String Configuration log format value.
messageSize Object Logs message size value. Contains ID (dictId) from message size dictionary.
productGroupId Number Configuration product group identifier. The productGroupId mapping to a list of products for available ACG is in the PRODUCT_GROUPS_FOR_ACGS dictionary.
startDate String Start date of Log Delivery. Contains a Moment object serialized to JSON.
Optional
aggregationType Enumeration Type of aggregation value, either COLLECTION or CALENDAR.
configurationType Enumeration Type of configuration, either SPIN, SHADOW, or PRIMARY.
cpCode Object Deprecated. Configuration CP code for CP code configurations. Contains ID of the CP code (dictId) and description (dictValue).
deletedDate String Deletion date of Log Delivery. Not empty means that Log Delivery no longer exists. Contains a Moment object serialized to JSON.
deliverResidualFlag Boolean Deliver residual data flag. Required if Aggregationtype is Calendar.
deliverResidual Number Deliver residual data flag. A null value means false, 1 means true.
deliveryFrequency Object Log delivery frequency value. Contains ID (dictId) from delivery frequency dictionary. Required If Aggregationtype is Collection.
deliveryThreshold Enumeration Log delivery threshold value, either 99, 99.5, 99.9, or 99.99. Required if Aggregationtype is Calendar.
deliveryType Enumeration Type of log delivery method, either FTP or EMAIL.
dnsZone Object Deprecated. DNS zone for EDNS configurations. Contains ID of the DNS zone (zoneId) and zone name (zoneName).
emailConfiguration Object Log delivery destination for email configuration, contains an emailAddress field. Required if deliveryType is EMAIL.
encodingKey String Public key value for GPG encrypted encoding. Required if encoding.dictId is 4.
endDate String End date of Log Delivery. Contains serialized to JSON Moment object.
ftpConfiguration Object Contains FTP machine address, login, password, and path to the destination directory. Required if the deliveryType is FTP.
serviceId Number ID of the configuration.
status Enumeration Configuration status information, either NONE, ACTIVE, EXPIRED, or SUSPENDED.
type String Deprecated. Type of configuration, either CpCodeConfiguration or EdnsConfiguration. Only applies to CP code or EDNS configurations.

ConfigurationCopy

Member Type Description
Required
acgObjectId String Unique identifier for the AcgObject, available from the PRODUCT_GROUPS_FOR_ACGS dictionary.
acgObjectType Enumeration Type of acgObject, either CP_CODE, EDNS, or GTM_PROPERTY.
productGroupId Number Unique integer identifier for the configuration product group. The productGroupId that maps to a list of products for available ACG is in the PRODUCT_GROUPS_FOR_ACGS dictionary.

Redelivery

Member Type Description
Required
beginTime Number First hour of time range (0–23) from which logs redelivery is requested.
createdDate String Date of redelivery creation.
endTime Number Last hour of time range (1–24) from which logs redelivery is requested.
id Number Unique integer identifier for the redelivery.
modifiedDate String Date of last redelivery modification.
redeliveryDate String Date (day, month, year) from which logs redelivery is requested.
serviceId Number Identifier of the configuration.
status Enumeration Status of the redelivery, either NEW, SCHEDULED, SUCCESS, or FAILED.

Last modified: 4/6/2017