Skip to main content

Clari Revenue Data Source

The Clari Revenue connector enables you to ingest revenue intelligence data—including forecast and activity exports, opportunity records, audit events, export and ingest job status, and schema picklist values—from the Clari API. Follow the instructions below to create a new data flow that ingests data from a Clari Revenue source in Nexla.
clari_api.png

Clari Revenue

Create a New Data Flow​

  1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

  2. Select the Clari Revenue connector tile from the list of available connectors. Then, select the credential that will be used to connect to the Clari Revenue instance, and click Next; or, create a new Clari Revenue credential for use in this flow.

  3. In Nexla, Clari Revenue data sources can be created using pre-built endpoint templates, which expedite source setup for common Clari Revenue endpoints. Each template is designed specifically for the corresponding Clari Revenue endpoint, making source configuration easy and efficient.
    • To configure this source using a template, follow the instructions in Configure Using a Template.

    Clari Revenue sources can also be configured manually, allowing you to ingest data from Clari Revenue endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Clari Revenue endpoints. Each template is designed specifically for the corresponding Clari Revenue endpoint, making data source setup easy and efficient.

Endpoint Settings​

  • Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

    Create Forecast Export

    This endpoint initiates a new forecast export job in Clari. Use it to export manual forecast submissions and related data—such as pipeline and quota—for a specified forecast and time period. The endpoint returns a job identifier that can be polled with the Get Job Status endpoint and retrieved with the Download Export Results endpoint once the job completes.

    • Enter the ID of the forecast to export in the Forecast ID field. This is the only required parameter and identifies the forecast whose data will be exported.
    • Enter the time period to include in the Time Period field (for example, a fiscal quarter such as 2026_Q2) to scope the export to a specific reporting period.
    • Enter a comma-separated list of data types to include in the Types to Export field, such as forecast,pipeline,quota.
    • Enter a Scope ID to filter the export to a specific organizational scope, hierarchy, or team.
    • Enter the Currency to use for numeric values in the export. This defaults to USD.
    • Enter a Schedule value if the export should run on a recurring or automated basis.
    • Set Include Historical to true to include historical data in the export, or leave it as false to export only current data.
    • Select the output format for the exported file from the Export Format field. Available values are JSON, CSV, and Excel, with JSON selected by default.

    Forecast exports are processed asynchronously. After creating the export, use the Get Job Status endpoint to monitor progress, then use the Download Export Results endpoint to retrieve the completed data.

    Create Activity Export

    This endpoint creates and submits a new activity data export job for a specified date range. Use it to export sales activity records—such as calls, emails, and meetings—captured in Clari.

    • Enter a comma-separated list of activity types to include in the Activity Types field, such as call,email,meeting. Leave this field empty to include all activity types.
    • Enter the beginning date for the export period in the Start Date field using YYYY-MM-DD format. This field defaults to the macro {now-30}, which resolves to 30 days before the current date.
    • Enter the ending date for the export period in the End Date field using YYYY-MM-DD format. This field defaults to the macro {now}, which resolves to the current date.
    • Select the output format for the exported file from the Export Format field. Available values are JSON, CSV, and Excel, with JSON selected by default.

    The {now} and {now-30} macros are dynamic datetime placeholders that Nexla resolves at run time, making it easy to maintain a rolling export window across scheduled ingestion runs.

    Get Job Status

    This endpoint retrieves the current status of an export job by its ID. Use it to determine whether a forecast or activity export job is still processing, has completed, or has failed before attempting to download its results.

    • Enter the ID of the export job to check in the Job ID field. This is the job identifier returned when the export was created.

    Job IDs are returned by the Create Forecast Export and Create Activity Export endpoints. You can also retrieve all of your export jobs and their IDs using the List Export Jobs endpoint.

    Download Export Results

    This endpoint downloads the results of a completed export job. Use it once an export job's status indicates that it has finished processing to ingest the exported forecast or activity data into Nexla.

    • Enter the ID of the export job whose results you want to download in the Job ID field.

    Confirm that the export job has completed using the Get Job Status endpoint before downloading results, as results are not available until processing finishes.

    List Export Jobs

    This endpoint lists all export jobs initiated by the current user. Use it to review existing export jobs, retrieve their job IDs, and monitor the overall state of your exports.

    • This endpoint requires no additional configuration beyond selecting the endpoint template. Nexla reads each job from the jobs array in the response and treats it as an individual record.

    Use this endpoint to discover the job IDs needed by the Get Job Status, Download Export Results, and Update Job endpoints.

    Update Job

    This endpoint stops or cancels an export job that is currently in progress. Use it to halt a running export—for example, if it was configured incorrectly or is no longer needed.

    • Enter the ID of the export job to stop or cancel in the Job ID field.
    • Select the action to perform from the Action Type field. Available values are Stop and Cancel.

    The Stop and Cancel actions terminate an in-progress export job. Retrieve the job ID using the List Export Jobs endpoint if it is not already known.

    Get Opportunity

    This endpoint fetches opportunity data from Clari, with optional filtering by opportunity ID and mode. Use it to ingest opportunity records for pipeline analysis, reporting, or syncing into a data warehouse.

    • Enter an Opportunity ID to filter results to a specific opportunity. Leave this field empty to retrieve opportunities more broadly.
    • Enter a Mode value to control how opportunity data is retrieved (for example, forecast or actual).

    Nexla reads each opportunity from the opportunities array in the response and treats it as an individual record.

    List Audit Events

    This endpoint retrieves a paginated list of audit events with optional filtering. Use it to ingest a record of administrative and user activity within your Clari organization. Nexla automatically handles offset-based pagination to retrieve all matching events.

    • Enter an Actor ID to filter events by the ID of the user who initiated the action.
    • Enter an Impersonating Actor ID to filter events by the ID of the user being impersonated.
    • Enter a Session ID to filter events by a specific session.
    • Enter a Session Type to filter events by the type of session.
    • Enter the Date From value to set the inclusive start date for the events. This field defaults to the macro {now-30}, which resolves to 30 days before the current date.
    • Enter the Date To value to set the inclusive end date for the events. This field defaults to the macro {now}, which resolves to the current date.
    • Enter an Event value to filter by a specific event type.

    The Clari audit events endpoint typically returns data for the past 30 days only, which aligns with the default {now-30} start date. Nexla reads each event from the events array in the response.

    Export Audit Events

    This endpoint creates an asynchronous job to export audit events filtered by specified criteria. Use it when you need a larger or more durable export of audit activity than the synchronous List Audit Events endpoint provides. The endpoint returns a job that can be monitored and downloaded using the job endpoints.

    • Enter an Actor ID to filter events by the ID of the user who initiated the action.
    • Enter an Impersonating Actor ID to filter events by the ID of the user being impersonated.
    • Enter a Session ID to filter events by a specific session.
    • Enter a Session Type to filter events by the type of session.
    • Enter the Date From value to set the inclusive start date for the export. This field defaults to the macro {now-30}.
    • Enter the Date To value to set the inclusive end date for the export. This field defaults to the macro {now}.
    • Enter an Event value to filter by a specific event type.

    Because this export is asynchronous, use the Get Job Status endpoint to monitor the job and the Download Export Results endpoint to retrieve the exported audit events once processing completes.

    Get Ingest Job Status

    This endpoint retrieves the status of a data ingestion job by job ID. Use it to monitor the progress of entity data that has been uploaded to Clari through the Ingest Bulk Entities or Upload Entity Data destination endpoints.

    • Enter the ID of the ingestion job to check in the Job ID field. This is the job identifier returned when the ingest job was created.

    Ingest job IDs are produced by the Clari ingest endpoints. This endpoint is commonly used to confirm that an entity upload completed successfully before continuing downstream processing.

    Get Picklist Values

    This endpoint retrieves picklist or multi-picklist field values for a specified entity. Use it to discover the valid values for a field before ingesting entity data, ensuring that the values you send conform to the entity's schema.

    • Select the entity type whose picklist values you want to retrieve from the Entity Type field. Available values are Account, Contact, and Opportunity.
    • Enter a comma-separated list of field names in the Field Names field to retrieve picklist values for specific fields. Leave this field empty to retrieve values across applicable fields.

    Use this endpoint together with the Add Picklist Values endpoint to manage the allowed values for picklist fields in your Clari entity schema.

    Add Picklist Values

    This endpoint adds new picklist or multi-picklist field values to an entity schema. Use it to extend the set of allowed values for a field before ingesting entity data that relies on those values.

    • Select the entity type to which values will be added from the Entity Type field. Available values are Account, Contact, and Opportunity.
    • Enter the name of the picklist field to add values to in the Field Name field.
    • Select the field type from the Field Type field. Available values are Picklist and Multi-Picklist.
    • Enter a comma-separated array of values to add in the Values field, such as "Open","Closed","Pending".

    The Entity Type, Field Name, Field Type, and Values fields are all required for this endpoint. Use the Get Picklist Values endpoint to review existing values before adding new ones.

    Get Limits

    This endpoint retrieves API and export limit information for your organization. Use it to review the quotas and rate limits that apply to your Clari account, which can help you plan export and ingest activity accordingly.

    • This endpoint requires no additional configuration beyond selecting the endpoint template.

    This endpoint is the same one Nexla uses to validate your Clari Revenue credential, so a successful credential test confirms that the endpoint is reachable.

Endpoint Testing​

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually​

Clari Revenue data sources can be manually configured to ingest data from any valid Clari API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

With manual configuration, you can also create more complex Clari Revenue sources, such as sources that use chained API calls to fetch data from multiple endpoints or sources that require custom request parameters.

API Method​

  1. To manually configure this source, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the Clari API from the Method pulldown menu. The most common methods are:

    • GET: For retrieving data from the API
    • POST: For sending data to the API or triggering actions
    • PUT: For updating existing data
    • PATCH: For partial updates to existing data
    • DELETE: For removing data

API Endpoint URL​

  1. Enter the URL of the Clari API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including the protocol (https://) and any required path parameters—for example, https://api.clari.com/v1/opportunity.

Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL.

Date/Time Macros (API URL)​

Optional

Optionally, the API URL can be customized using macros—all macros added to the API URL will be converted into values when Nexla executes the API call. Macros are dynamic placeholders that allow you to create flexible API endpoints that can adapt to different time periods or data requirements. This is especially useful for Clari endpoints that accept dateFrom and dateTo parameters, such as the audit and activity endpoints.

Macros are particularly useful for APIs that require date ranges, pagination parameters, or other dynamic values that change between data ingestion runs.

  1. To add a macro, type { at the appropriate position in the API URL (within the Set API URL field), and select the desired macro from the dropdown list.

    • {now} – The current datetime
    • {now-1} – The datetime one time unit before the current datetime
    • {now+1} – The datetime one time unit after the current datetime
    • custom – Datetime macros can reference any number of time units before or after the current datetime—for example, enter (now-4) to indicate the datetime four time units before the current datetime

  2. Select the format that will be applied to datetime macros from the Date Format for Date/Time Macro pulldown menu. This format will be applied to the base datetime value of the macro—i.e., the value of {now} in {now-1}.

  3. Select the datetime unit that will be used to perform mathematical operations in the included macro(s) from the Time Unit for Operations pulldown menu—for example, for the macro {now-1}, when Day is selected, {now-1} will be converted to the datetime one day before the current datetime.

Path to Data​

Optional

If only a subset of the data that will be returned by the API endpoint is needed, you can designate the part(s) of the response that should be included in the Nexset(s) produced from this source by specifying the path to the relevant data within the response. This is particularly useful when API responses contain metadata, pagination information, or other data that you don't need for your analysis.

For example, the Clari audit events endpoint returns an array of records under an events key, and the opportunity endpoint returns records under an opportunities key. By entering the path to the relevant data, you can configure Nexla to treat each element of the returned array as a record.

Path to Data is essential when API responses have nested structures. Without specifying the correct path, Nexla might not be able to properly parse and organize your data into usable records.

  • To specify which data should be treated as relevant in responses from this source, enter the path to the relevant data in the Set Path to Data in Response field.

    • For responses in JSON format enter the JSON path that points to the object or array that should be treated as relevant data. JSON paths use dot notation (e.g., $.events[*] to access an array of audit events, or $.opportunities[*] to access an array of opportunities).
    Path to Data Example:

    If the API response is in JSON format and includes a top-level array named events that contains the relevant data, the path to the response would be entered as $.events[*].

Autogenerate Path Suggestions​

Nexla can also autogenerate data path suggestions based on the response from the API endpoint. These suggested paths can be used as-is or modified to exactly suit your needs.

  • To use this feature, click the Test button next to the Set API URL field to fetch a sample response from the API endpoint. Suggested data paths generated based on the content & format of the response will be displayed in the Suggestions box below the Set Path to Data in Response field.

  • Click on a suggestion to automatically populate the Set Path to Data in Response field with the corresponding path. The populated path can be modified directly within the field if further customization is needed.

    PathSuggestions.png

Metadata​

If metadata is included in the response but is located outside of the defined path to relevant data, you can configure Nexla to include this data as common metadata in each record. This is useful when you want to preserve important contextual information that applies to all records but isn't part of the main data array.

For example, a Clari list response may include an array of records along with metadata such as pagination details or total counts. In this case, if you have specified the path to the relevant data but metadata of interest is located in a different part of the response, you can specify a path to this metadata to include it with each record in the generated Nexset(s).

Metadata paths are particularly useful for preserving API response context like request IDs, timestamps, or summary statistics that apply to all records in the response.

  • To specify the location of metadata that should be included with each record, enter the path to the relevant metadata in the Path to Metadata in Response field.

    • For responses in JSON format, enter the JSON path to the object or array that contains the metadata.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this source, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2). Additional headers are often required for API versioning, content type specifications, or custom authentication requirements.

    You do not need to include any headers already present in the credentials. The Authorization bearer token configured in your Clari Revenue credential is applied automatically to each request.

Endpoint Testing​

After configuring all settings for the selected endpoint, Nexla can retrieve a sample of the data that will be fetched according to the current configuration. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Save & Activate the Source​

  1. Once all of the relevant steps in the above sections have been completed, click the Create button in the upper right corner of the screen to save and create the new Clari Revenue data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.