Push API Leading Practices

Keep the following leading practices in mind when using the Push API.

Avoid Using Custom Push API Operations on Product-Managed Push Sources

Never perform custom Push API operations to interact directly with Coveo Crawling Module or Coveo for Sitecore Push sources.

Otherwise, you risk causing irreparable damage to your index.

Avoid Setting Custom orderingId Values

Let the service deal automatically with the orderingId parameter when making Push API calls (except when performing delete older than operations).

If you have a good reason for setting your own orderingId values, proceed with caution (see Understanding the orderingId Parameter).

Prioritize Batch Operations

Use single operations only when testing, or when performing small content/security identity updates. Use batch operations the rest of the time.

See:

Using batch operations allows you to to keep your number of Push API calls per hour relatively low (see Push API Limits).

Update Your Push Source Status

Consider updating the status of a Push source before and after a complete set of operations corresponding to a content update (see Updating the Status of a Push Source).

For instance, right before you start a process that retrieves new and/or updated content to be indexed in a Push source, you should set the status of that source to REBUILD, RESCAN, or REFRESH, as appropriate. You should then set the status of that source back to IDLE right after you have finished performing the entire set of Push API operations that actually forward the content update to your index.

Updating your Push source status allows you to keep coherent source activity logs in your Coveo Cloud organization.

Perform Security Identity Updates After Content Updates

If your Push source has item-based permissions, perform a security identity update immediately after each content update.

Doing so minimizes the period of time during which security identity relationships may not be entirely up-to-date in the security identity cache.