Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

update http api guide with batch limit #7023

Draft
wants to merge 1 commit into
base: develop
Choose a base branch
from
Draft

update http api guide with batch limit #7023

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions src/connections/sources/catalog/libraries/server/http-api/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -461,8 +461,9 @@ When sending a HTTP call from a user's device, you can collect the IP address by

Segment returns a `200` response for all API requests except errors caused by large payloads and JSON errors (which return `400` responses.) To debug events that return `200` responses but aren't accepted by Segment, use the Segment Debugger.

Common reasons events are not accepted by Segment include:
- **Payload is too large:** The HTTP API can handle API requests that are 32KB or smaller. The batch API endpoint accepts a maximum of 500KB per request, with a limit of 32KB per event in the batch. If these limits are exceeded, Segment returns a 400 Bad Request error.
Common reasons that events are not accepted by Segment:
- **Payload is too large:** Most HTTP API routes can handle API requests that are 32KB or smaller. If this limit is exceeded, Segment returns a 400 Bad Request error.
- **The `\batch` API endpoint** This endpoint accepts a maximum of 500KB per batch API request. Additionally, each batch request can only have up to 2500 events, and each batched event needs to be less than 32KB. Segment will return a `200` response but reject the event, when the number of batched events exceeds limit.
- **Identifier is not present**: The HTTP API requires that each payload has a userId and/or anonymousId. If you send events without either the userId or anonymousId, Segment’s tracking API responds with an no_user_anon_id error. Check the event payload and client instrumentation for more details.
- **Track event is missing name**: All Track events sent to Segment must have an `event` field.
- **Deduplication**: Segment deduplicates events using the `messageId` field, which is automatically added to all payloads coming into Segment. If you're setting up the HTTP API yourself, ensure all events have unique messageId values with fewer than 100 characters.
Expand Down