유저 및 이벤트 정보 전송

이 페이지에서는 이벤트 및 유저 데이터 전송에 대한 Open API 스펙을 명시합니다.

사전 작업

서버에서 이벤트를 전송하기 전, 먼저 프로젝트에 유효한 토큰을 발급받아 주세요.

인증 토큰 발급 방법chevron-right

1. 개요

이벤트 및 유저 데이터를 전송할 수 있도록 제공하는 Open API입니다. 이벤트, 이벤트 속성, 유저에 대한 자세한 설명은 아래 문서에서 확인하세요.

서버에서 Event 및 User 데이터 연동 방법chevron-right

2. 인증

API를 사용하려면 서버에서 발급받은 API 키를 Authorization 헤더에 포함해야 합니다.

Authorization: Bearer {your_api_key}

또한, 모든 요청에는 프로젝트 ID가 필요합니다.

이를 쿼리 파라미터에 포함하여 전송합니다.

?project_id=your_project_id

3. Open API 명세서

  • timestamp 값으로 이벤트가 발생한 시간을 명시하는 경우, ISO 8601 arrow-up-right표준에 맞게 전달해주세요.

    • 예) "2025-01-17T05:39:22Z", "2025-01-17T05:39:22+09:00"

triangle-exclamation
  • bulk 요청 시, 한 번의 호출당 profilesevents 각각 1,000개 이하로 요청해주세요.

Update bulk user profiles

post

Updates user profile information in bulk.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
project_idstringRequired

The ID of the project.

Example: your_project_id
Body
Responses
post
/v1/api/profile/user

No content

Collect bulk user events

post

Receives a list of events and processes them asynchronously.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
project_idstringRequired

The ID of the project.

Example: your_project_id
Body
Responses
post
/v1/api/events

No content

Request user profile deletion

post

Creates an asynchronous deletion job for the specified user profile.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
project_idstringRequired

The ID of the project.

Example: your_project_id
Body
user_idstringRequiredExample: test-user-123
Responses
post
/v1/api/profile/user/deletion-job

No content

Request bulk user profile deletion

post

Triggers asynchronous deletion of multiple user profiles.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
project_idstringRequired

Project ID

Example: your_project_id
Body
user_idsstring[] · min: 1Required
Responses
post
/v1/api/profile/user/deletion-job/bulk

No content

Update bulk device profiles

post

Updates device profile information and user-device mapping in bulk.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
project_idstringRequired

The ID of the project.

Example: your_project_id
Body
Responses
post
/v1/api/profile/user/device/bulk

No content

Last updated

Was this helpful?