Get Credentials

Get credentials

Adobe is working on improving the 'Try it' functionality. In the meantime, you can authenticate in your own environment to use these API calls.

Bulk Data Insertion API (BDIA) (1.0)

Download OpenAPI specification:Download

The BDIA endpoint allows clients to send bulk hit/event data into Analytics.

Note: Adobe may add optional request and response members (name/value pairs) to existing API objects at any time and without notice or changes in versioning. Adobe recommends that you refer to the API documentation of any third-party tool you integrate with our APIs so that such additions are ignored in processing if not understood. If implemented properly, such additions are non-breaking changes for your implementation. Adobe will not remove parameters or add required parameters without first providing standard notification through release notes.

events

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
Request
query Parameters
debug
boolean
Default: false

Store debug information for the first 10 hits of the file

header Parameters
x-adobe-vgid
required
string

Visitor Group ID. A visitor group represents a bucketed group of visitor IDs that are disjoint from any other visitor group set. The Group ID is a string, and can be whatever value you wish, but it must be consistent across files. Please see the documentation for details on this important concept.

Request Body schema: multipart/form-data
required
file
required
string <binary>

Gzip compressed CSV file sent with request

Responses
200

OK

400

Request Error

401

Unauthorized Access

post/events
Response samples
application/json
{
  • "file_id": "5c04f400-fca5-420c-9c36-b94aaec55e69",
  • "visitor_group_id": "myvisitorgroup1",
  • "size": 355600,
  • "received_date": 1506553535,
  • "processing_start_date": 1506553492,
  • "processing_end_date": 1506553492,
  • "file_reader_complete_date": 1506553492,
  • "rows": 10000,
  • "invalid_rows": 42,
  • "upload_name": "myfile1.gz",
  • "status": "string",
  • "status_code": "UPLOADED",
  • "processing_log": "string",
  • "error": "File not in GZIP format",
  • "success": "File is valid"
}

Upload a batch file to Analytics for validation

This file will not be stored on the server or processed into Analytics. Validate is used only for testing your file format.

Request
Request Body schema: multipart/form-data
required
file
required
string <binary>

Gzip compressed CSV file sent with request

Responses
200

OK

400

Request Error

401

Unauthorized Access

post/events/validate
Response samples
application/json
{
  • "file_id": "5c04f400-fca5-420c-9c36-b94aaec55e69",
  • "visitor_group_id": "myvisitorgroup1",
  • "size": 355600,
  • "received_date": 1506553535,
  • "processing_start_date": 1506553492,
  • "processing_end_date": 1506553492,
  • "file_reader_complete_date": 1506553492,
  • "rows": 10000,
  • "invalid_rows": 42,
  • "upload_name": "myfile1.gz",
  • "status": "string",
  • "status_code": "UPLOADED",
  • "processing_log": "string",
  • "error": "File not in GZIP format",
  • "success": "File is valid"
}