Troubleshooting Push source issues

Use a JSON validation tool to ensure that the body of your call is valid JSON.

If you’re pushing items, ensure that the request body is correctly formatted (see Item Models - DocumentBody).

If you’re pushing an uncompressed item, ensure that the request body minimally includes the data key-value pair (see Using the data Property).

If you’re pushing a small compressed item (less than 5 megabytes), ensure that the request body minimally includes the compressedBinaryData key-value pair (see Using the compressedBinaryData Property).

If you’re pushing a batch of items or a single large compressed item (5 megabytes or more), ensure that the request body minimally includes the compressedBinaryDataFileId key-value pair (see Using the compressedBinaryDataFileId Property).

If you’re using an API key to authenticate your call, this key may have been disabled or deleted in the target Coveo organization, or your IP address may not have access to this key. Ask an administrator to modify the API key accordingly or to create a new API key with the required privileges for you.

If you’re using an OAuth2 token to authenticate your call, this token may be expired. Try again using a fresh Coveo OAuth2 token (see Get your Coveo access token).

If you’re using an API key to authenticate your call, this API key probably doesn’t have the required privileges. Ask an administrator to modify the API key accordingly or to create a new API key with the required privileges for you.

If you’re using an OAuth2 token to authenticate your call, your identity probably doesn’t have the required privileges in the target Coveo organization, if not already done. Ask an administrator to grant you those privileges or to create an API key for you with the required privileges.

Create a new file container.

Use the new container’s uploadUri to upload item batches and its fileId to transfer the content into your source.

If you’re pushing uncompressed raw textual item data, ensure that it’s UTF-8 encoded.

Ensure that your batch document is a valid JSON object.

Consider decreasing or splitting up the number of Push API operations in a single batch (see Manage batches of items in a Push source).

Ensure that there are no duplicate keys within the JSON batch document.

Ensure that you have correctly spelled the sourceId of the target source.

Ensure that the source you want to push content into has been successfully created in the target Coveo organization.

If you’re pushing a single compressed or uncompressed item whose data size exceeds 5 megabytes, use a large file container to push the item, rather than directly providing its data or compressedBinaryData in the body of the call (see Using the compressedBinaryDataFileId Property).

If you’re pushing a batch of items whose total size exceeds 256 megabytes, try pushing smaller batches.

If you’re using a large file container to push a single large item whose uncompressed size exceeds 256 megabytes, try compressing the item using one of the supported algorithms (Deflate, GZip, LZMA, or ZLib) before pushing it again.

A possibility is that you have exceeded one of your daily Push API limits (that is, your number of daily Push API calls) with the number of items processed daily by the Push API, or the number of security identities processed daily by the Push API. You can see whether this is the case by reviewing your current usage of your organization limits.

This error can also occur when first using the Push API after a period of inactivity (around 15 minutes). In such cases, the Push API needs to perform requests to other Coveo APIs, and it’s possible to exceed the allowed number of requests in a given amount of time, or the allowed number of concurrent requests to those other APIs. As a consequence, you may be throttled by those other APIs.

Coveo declined your request due to a reduced indexing capacity.

If you have exceeded one of your daily Push API limits, wait until the limit resets, that is, until midnight UTC, and ensure you respect those limits going forward. We recommend that you implement an exponential backoff strategy to retry your calls after a certain amount of time.

If you have not exceeded one of your daily Push API limits, wait until your calls are no longer being throttled before using the service again. In the future, ensure that you make Push API calls at a slower pace, especially after a period of inactivity (see Push API Limits - Recommended Maximum Number of Items/Security Identities per Hour).

If you’re getting a 502 Bad Gateway error, ensure that the documentId for the item is properly URL-encoded, and then try again.

If you’re obviously not responsible for the error, try performing the operation again (with an exponential backoff). AWS issues typically resolve themselves, given enough time.

You can monitor the status of Coveo from status.cloud.coveo.com.