Ingest Data.

POST /api/teams/{teamId}/ingest

This endpoint handles all ingestion of data into the system, including enrolments, impressions and conversions.


Participants may only be enrolled into a running experiment.

Path parameters

  • teamId integer Required

    The ID of the team.

application/json

Body Required

  • experiment string Required

    The key of the experiment to enroll in.

  • variant string Required

    The key of the variant to enroll the participant into.

  • participant string Required

    The key of the participant to enroll. The participant will automatically be created if it does not yet exist.

  • event string

    The key of the event that converted. Only required during a conversion.

  • force boolean

    Whether to force the enrollment. By default, if the participant is already enrolled in the experiment, the enrollment will be ignored. Defaults to false.

Responses

  • 202 text/plain
  • 402 application/json
    Hide response attribute Show response attribute object
  • 403 application/json
    Hide response attribute Show response attribute object
  • 404 application/json
    Hide response attribute Show response attribute object
POST /api/teams/{teamId}/ingest 
curl \
 -X POST https://checkmango.com/api/teams/10/ingest \
 -H "Content-Type: application/json" \
 -d '{"experiment":"CHECKOUT_CTA","variant":"CTA_RED","participant":"jbrooksuk","event":"CHECKOUT","force":true}'
Request example 
{
  "experiment": "CHECKOUT_CTA",
  "variant": "CTA_RED",
  "participant": "jbrooksuk",
  "event": "CHECKOUT",
  "force": true
}
Response examples (402) 
{
  "message": "Subscription required."
}
Response examples (403) 
{
  "message": "Unauthenticated."
}
Response examples (404) 
{
  "message": "Not Found"
}