Validate import upload

POST

/api/sites/{id}/imports/uploads/{importID}/validate

curl --request POST \
  --url https://hitkeep.com/api/sites/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/imports/uploads/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/validate \
  --cookie hk_token=<hk_token>

Scans staged files row by row and returns the validation manifest without committing analytics rows.

Authorizations

• cookieAuth
• bearerAuth
• apiKeyAuth

Parameters

Path Parameters

id

required

string format: uuid

importID

required

string format: uuid

Responses

200

Import job

Media type application/json

object

bytes_received

integer

bytes_total

integer

error

string

id

string format: uuid

manifest

object

datasets

Array<object>

object

events

integer

files

Array<string>

key

string

name

string

pageviews

integer

rows_accepted

integer

rows_scanned

integer

rows_skipped

integer

visitors

integer

visits

integer

date_end

string format: date-time

date_start

string format: date-time

event_coverage

object

event_names

Array<string>

events

Queryable imported custom-event count.

integer

property_keys

Array<string>

rows_accepted

integer

rows_scanned

integer

visitors

integer

event_dimension_coverage

object

available

Array<string>

reason

string

unavailable

Array<string>

event_property_coverage

object

attributed_events

integer

attributed_property_keys

Array<string>

attributed_rows

integer

attributed_visitors

integer

unattributed_events

integer

unattributed_property_keys

Array<string>

unattributed_relationship

string

unattributed_rows

integer

unattributed_visitors

integer

unavailable_relationship_message

string

files

Array<string>

ignored_files

Array<string>

missing_files

Array<string>

overlap

object

estimated_skipped_events

integer

estimated_skipped_pageviews

integer

estimated_skipped_rows

integer

native_event_days

integer

native_event_keys

integer

native_traffic_days

integer

policy

string

Allowed values: skip_native_day

provider

string

rows_accepted

integer

rows_scanned

integer

rows_skipped

integer

source_hash

string

warnings

Array<object>

object

code

string

file

string

message

string

provider

string

rows_imported

integer

rows_scanned

integer

site_id

string format: uuid

source_hash

string

status

string

Example

{
  "manifest": {
    "overlap": {
      "policy": "skip_native_day"
    }
  }
}

400

Validation failed

Media type application/json

object

message

string

Example ^generated

{
  "message": "example"
}