Events

Upload file for processing

Upload a batch file to Analytics for processing. Uploaded files must:

  • Be 100 MB or less compressed (using gzip)
  • Follow the CSV formatting rules and include the required fields as specified in the documentation
post/events

Request

  • Base URL: https://analytics-collection.adobe.io/aa/collect/v1
  • URL: https://analytics-collection.adobe.io/aa/collect/v1/events
  • Auth: none declared. Required headers: Authorization, x-api-key, x-adobe-vgid

Query parameters

debugboolean

Store debug information for the first 10 hits of the file

Headers

Authorizationstring required

The access token from your OAuth Server-to-Server credential, prefixed with "Bearer ".

x-api-keystring required

The Client ID (API key) from your OAuth Server-to-Server credential in the Adobe Developer Console.

x-adobe-vgidstring required

Visitor Group ID. A visitor group represents a bucketed group of visitor IDs that are separate from any other visitor group set. The Group ID is a string of any valid value, but must be consistent across files. See Visitor groups for more information.

x-adobe-idempotency-keystring

Optional. A client-generated unique reference for the upload, used for duplication protection when a request does not return a response. If omitted, it defaults to the generated file_id.

Response

OK

file_idstring

The file ID as a GUID

visitor_group_idstring

The visitor group of the file

sizeinteger

The size of the compressed file in bytes

received_dateinteger

The date the file was uploaded in unix epoch time.

rowsinteger

The number of rows in the file

invalid_rowsinteger

The number of rows not submitted to analytics for being invalid

upload_namestring

The file name as it was uploaded

statusstring

The status of the file

status_code'REJECTED' | 'UPLOADED' | 'PROCESSING' | 'COMPLETE' | 'ERROR'

The status of the file as a short name

processing_logstring

A log of errors produced while processing the file

idempotency_keystring

Either the value of the x-adobe-idempotency-key if supplied, or the file_id

errorstring

An error message for unsuccessful requests

Example response

{
  "file_id": "9c99f999-fca9-999c-9c99-b99aaec99e99",
  "visitor_group_id": "myvisitorgroup1",
  "size": 355600,
  "received_date": 1506999999,
  "rows": 10000,
  "invalid_rows": 42,
  "upload_name": "myfile1.gz",
  "status_code": "UPLOADED",
  "error": "File not in GZIP format"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.