Initial configuration

This is for:

Developer System Administrator

In this article

Create your organization
Familiarize yourself with the Administration Console
What’s next?

This article focuses on the initial configuration phase of your search project.

Create your organization

Before you can start working on your search project with the Coveo Platform, you must create an organization. You can do this in one of several ways:

Contact a Coveo Sales representative to set up an organization for you.
Start a free trial with a new trial organization.
Create a test organization^[1] from the organization drop down menu in the Coveo Administration Console.
If you have an account on Level Up, the Coveo educational platform, you can create a test organization from the Test Organizations section of your user profile.
Use the Coveo CLI to create a test organization.
Use the Platform API to create a test organization.

You will typically use the Administration Console or CLI to interact with your organization and the various resources it hosts for you. If necessary, you can invoke the Platform API directly to achieve the same results.

Familiarize yourself with the Administration Console

The following screen capture and accompanying table provide a high-level overview of some of the common interactions you can perform through the Administration Console (platform-ca | platform-eu | platform-au). Each UI section detailed in the table includes a link to the corresponding documentation corpus, as well as a list of APIs leveraged by that section.

Cove Platform resources overview | Coveo

Section	Common interactions	Documentation	APIs
1	If you have access to more than one organization (for example, staging and production), select the desired one	Organization picker	N/A
2	Manage critical updates Manage user notifications	Critical updates User notifications	Platform API Notification API
3	Manage sources, fields, and indexing pipeline extensions (IPEs) Review indexing pipeline logs Interact with the security identity cache and security identity providers Access the Content Browser Monitor your Crawling Modules	Index content	Extension API Field API Index API Search API Security Cache API Source API Source Logs API
4	Manage features specific to Coveo for Commerce	Coveo for Commerce	Commerce API
5	Manage query pipelines and hosted search pages	Optimize search	Search API
6	Review Coveo Machine Learning (Coveo ML) models	Leverage machine learning	Machine Learning API
7	Manage usage analytics reports, data exports, dimensions, named filters, and permission filters Review incoherent UA events	Coveo Usage Analytics overview	Activity API Usage Analytics Read API
8	Manage organization groups, members, and API keys Manage administrator notifications Access the activity Browser Review license information and manage organization settings	Manage an organization	Activity API Authorization Server API Notification API
9	Review organization status	Status	Platform API

Section

Common interactions

Documentation

APIs

If you have access to more than one organization (for example, staging and production), select the desired one

Organization picker

N/A

Manage critical updates
Manage user notifications

Manage sources, fields, and indexing pipeline extensions (IPEs)
Review indexing pipeline logs
Interact with the security identity cache and security identity providers
Access the Content Browser
Monitor your Crawling Modules

Index content

Manage features specific to Coveo for Commerce

Coveo for Commerce

Commerce API

Manage query pipelines and hosted search pages

Optimize search

Search API

Review Coveo Machine Learning (Coveo ML) models

Leverage machine learning

Machine Learning API

Manage usage analytics reports, data exports, dimensions, named filters, and permission filters
Review incoherent UA events

Coveo Usage Analytics overview

Manage organization groups, members, and API keys
Manage administrator notifications
Access the activity Browser
Review license information and manage organization settings

Manage an organization

Review organization status

Status

Platform API

What’s next?

The Locate and index content section of this guide offers tips and tricks on how to retrieve, enhance, and index content to maintain a clean and up-to-date index. Applying its recommendations early in your search project will have a profound and positive impact thereafter.

1. Test organizations have limited performance and can’t be upgraded, so you should create a trial organization if you need more flexible limits.