{"note":"OpenAPI conversion -- returning structured metadata","name":"mixpanel-ingestion","description":"Ingestion API","version":"1.0.0","base_url":"https://api.mixpanel.com","endpoints":20,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Ingestion API\n@base https://api.mixpanel.com\n@version 1.0.0\n@endpoints 20\n@toc import(1), track(1), engage#profile-set(1), engage#profile-set-once(1), engage#profile-numerical-add(1), engage#profile-union(1), engage#profile-list-append(1), engage#profile-list-remove(1), engage#profile-unset(1), engage#profile-batch-update(1), engage#profile-delete(1), groups#group-set(1), groups#group-set-once(1), groups#group-unset(1), groups#group-remove-from-list(1), groups#group-union(1), groups#group-batch-update(1), groups#group-delete(1), lookup-tables(2)\n\n@group import\n@endpoint POST /import\n@desc Import Events\n@required {strict: str(0/1)=1 # When set to 1 (recommended), Mixpanel will validate the batch and return errors per event that failed., project_id: str=<YOUR_PROJECT_ID> # The Mixpanel project_id, used to authenticate service account credentials.}\n@optional {Content-Type: str(application/json/application/x-ndjson)=application/json, Content-Encoding: str}\n@returns(200) {code: int, num_records_imported: int, status: str} # A 200 response indicates all records were successfully ingested.\n@errors {400: A 400 response indicates that some records failed validation., 401: A 401 response indicates invalid credentials., 413: A 413 response indicates that the payload is too large., 429: A 429 response indicates rate limits have been exceeded.}\n\n@endgroup\n\n@group track\n@endpoint POST /track\n@desc Track Events\n@returns(200) * `1` - One or more objects provided are valid. This does not signify a valid project token or secret. * `0` - No data objects in the body are valid.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group engage#profile-set\n@endpoint POST /engage#profile-set\n@desc Set Property\n@returns(200) * `1` - One or more objects provided are valid. This does not signify a valid project token or secret. * `0` - No data objects in the body are valid.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group engage#profile-set-once\n@endpoint POST /engage#profile-set-once\n@desc Set Property Once\n@returns(200) * `1` - One or more objects provided are valid. This does not signify a valid project token or secret. * `0` - No data objects in the body are valid.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group engage#profile-numerical-add\n@endpoint POST /engage#profile-numerical-add\n@desc Increment Numerical Property\n@returns(200) * `1` - One or more objects provided are valid. This does not signify a valid project token or secret. * `0` - No data objects in the body are valid.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group engage#profile-union\n@endpoint POST /engage#profile-union\n@desc Union To List Property\n@returns(200) * `1` - One or more objects provided are valid. This does not signify a valid project token or secret. * `0` - No data objects in the body are valid.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group engage#profile-list-append\n@endpoint POST /engage#profile-list-append\n@desc Append to List Property\n@returns(200) * `1` - One or more objects provided are valid. This does not signify a valid project token or secret. * `0` - No data objects in the body are valid.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group engage#profile-list-remove\n@endpoint POST /engage#profile-list-remove\n@desc Remove from List Property\n@returns(200) * `1` - One or more objects provided are valid. This does not signify a valid project token or secret. * `0` - No data objects in the body are valid.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group engage#profile-unset\n@endpoint POST /engage#profile-unset\n@desc Delete Property\n@returns(200) * `1` - One or more objects provided are valid. This does not signify a valid project token or secret. * `0` - No data objects in the body are valid.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group engage#profile-batch-update\n@endpoint POST /engage#profile-batch-update\n@desc Update Multiple Profiles\n@returns(200) * `1` - One or more objects provided are valid. This does not signify a valid project token or secret. * `0` - No data objects in the body are valid.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group engage#profile-delete\n@endpoint POST /engage#profile-delete\n@desc Delete Profile\n@returns(200) * `1` - One or more objects provided are valid. This does not signify a valid project token or secret. * `0` - No data objects in the body are valid.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group groups#group-set\n@endpoint POST /groups#group-set\n@desc Update Property\n@returns(200) * `1` - One or more objects provided are valid. This does not signify a valid project token or secret. * `0` - No data objects in the body are valid.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group groups#group-set-once\n@endpoint POST /groups#group-set-once\n@desc Set Property Once\n@returns(200) * `1` - One or more objects provided are valid. This does not signify a valid project token or secret. * `0` - No data objects in the body are valid.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group groups#group-unset\n@endpoint POST /groups#group-unset\n@desc Delete Property\n@returns(200) * `1` - One or more objects provided are valid. This does not signify a valid project token or secret. * `0` - No data objects in the body are valid.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group groups#group-remove-from-list\n@endpoint POST /groups#group-remove-from-list\n@desc Remove from List Property\n@returns(200) * `1` - One or more objects provided are valid. This does not signify a valid project token or secret. * `0` - No data objects in the body are valid.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group groups#group-union\n@endpoint POST /groups#group-union\n@desc Union To List Property\n@returns(200) * `1` - One or more objects provided are valid. This does not signify a valid project token or secret. * `0` - No data objects in the body are valid.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group groups#group-batch-update\n@endpoint POST /groups#group-batch-update\n@desc Batch Update Group Profiles\n@returns(200) * `1` - One or more objects provided are valid. This does not signify a valid project token or secret. * `0` - No data objects in the body are valid.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group groups#group-delete\n@endpoint POST /groups#group-delete\n@desc Delete Group\n@returns(200) * `1` - One or more objects provided are valid. This does not signify a valid project token or secret. * `0` - No data objects in the body are valid.\n@errors {401: Unauthorized, 403: Forbidden}\n\n@endgroup\n\n@group lookup-tables\n@endpoint GET /lookup-tables\n@desc List Lookup Tables\n@required {project_id: str=<YOUR_PROJECT_ID> # The Mixpanel project_id, used to authenticate service account credentials.}\n@returns(200) {code: num, status: str, results: [map]} # The list of Lookup Tables.\n@errors {401: A 401 response indicates invalid credentials.}\n\n@endpoint PUT /lookup-tables/{id}\n@desc Replace a Lookup Table\n@required {id: str(uuid) # The ID of the lookup table to replace which can be retreived from Lexicon under the lookup table's details, click [here](https://docs.mixpanel.com/docs/data-structure/lookup-tables#where-can-i-find-the-id-of-the-lookup-table-for-apis-path-params) for more info., project_id: str=<YOUR_PROJECT_ID> # The Mixpanel project_id, used to authenticate service account credentials.}\n@optional {Content-Type: str=text/csv}\n@returns(200) {code: int, status: str} # A 200 response indicates all records were successfully ingested.\n@errors {400: A 400 response indicates that some records failed validation., 401: A 401 response indicates invalid credentials., 404: A 404 response indicates that the entity to replace was not found., 413: A 413 response indicates that the payload is too large., 429: A 429 response indicates rate limits have been exceeded.}\n\n@endgroup\n\n@end\n"}