Ingest customer activity events

post/api/i/v1/{publicKey}/events

Path parameters

publicKeystring required

Request body

visitorIdstring uuid
fingerprintstring
source'client' | 'server' | 'integration'
sessionIdstring uuid

Response

Ingestion result

successboolean required
processedinteger required

Changes

Changed in 2 of the 33 revisions of this API.16315

  • 7fac501c267415315See the full diff
    • for the path request parameter publicKey, the minLength was increased from 0 to 1

      request-parameter-min-length-increased

    • the customerIdentity/customerId request property's minLength was increased from 0 to 1

      request-property-min-length-increased

    • the userIdentity/userId request property's minLength was increased from 0 to 1

      request-property-min-length-increased

    • removed PageviewEvent CustomEvent FormEvent IdentifyEvent EngagementEvent CalendarEvent from the events/items/ request property oneOf list

      request-property-one-of-removed

    • added the pattern ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ to the request property userIdentity/email

      request-property-pattern-added

    • added the pattern ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ to the request property visitorId

      request-property-pattern-added

    • added 'propertyNames' constraint to the request property customerIdentity/customerTraits

      request-property-property-names-added

    • added 'propertyNames' constraint to the request property userIdentity/traits

      request-property-property-names-added

    • the success response property const value false was removed for the status 400

      response-property-const-removed

    • the success response property const value false was removed for the status 500

      response-property-const-removed

    • the success response property const value true was removed for the status 200

      response-property-const-removed

    • removed the required property errors/items/path from the response with the 400 status

      response-required-property-removed

    • removed the required property errors/items/path from the response with the 500 status

      response-required-property-removed

    • removed the required property message from the response with the 400 status

      response-required-property-removed

    • removed the required property message from the response with the 500 status

      response-required-property-removed

    • the optional response header X-RateLimit-Limit removed for the status 200

      optional-response-header-removed

    • the optional response header X-RateLimit-Remaining removed for the status 200

      optional-response-header-removed

    • the optional response header X-RateLimit-Reset removed for the status 200

      optional-response-header-removed

    • api tag Ingest API removed

      api-tag-removed

    • added the new optional request property fingerprint

      new-optional-request-property

    • added the new optional request property sessionId

      new-optional-request-property

    • added the new optional request property userIdentity/fingerprint

      new-optional-request-property

    • removed the pattern ^pk_ from the path request parameter publicKey

      request-parameter-pattern-removed

    • added subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 subschema #6 to the events/items/ request property oneOf list

      request-property-one-of-added

    • removed the non-success response with the status 403

      response-non-success-status-removed

    • removed the non-success response with the status 429

      response-non-success-status-removed

    • added the optional property errors to the response with the 200 status

      response-optional-property-added

    • added the required property errors/items/index to the response with the 400 status

      response-required-property-added

    • added the required property errors/items/index to the response with the 500 status

      response-required-property-added

    • added the required property processed to the response with the 200 status

      response-required-property-added

    • added the required property processed to the response with the 400 status

      response-required-property-added

    • added the required property processed to the response with the 500 status

      response-required-property-added

    • added the success response with the status 207

      response-success-status-added

    This revision also has 208 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • removed StageEvent BillingEvent from the events/items/ request property oneOf list

      request-property-one-of-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog