Use the Push API
- Usage Example
- Leading Practices
- Manage Items and Permissions
- Manage Security Identities in a Security Identity Provider
- Update the Status of a Push Source
- Reset a Push Source
- Create a File Container
- orderingId Parameter
- API Processing Delay
- Troubleshoot API Error Codes
- API Reference
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 About 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.
Using batch operations allows you 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 example, 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
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.