Skip to main content

​
Intro

Aprimo helps you manage your marketing and content operations. Use Aprimo for digital asset management (DAM), workflow automation, planning, budgeting, and team collaboration. Industry analysts, like Gartner, recognize Aprimo as a leader in this space. For more information, refer to the API documentation. You can connect to your Aprimo account in the Data Center. This topic discusses the fields and menus that are specific to the Aprimo connector user interface. To add DataSets, set update schedules, and edit DataSet information, see Adding a DataSet Using a Connector.

​
Prerequisites

To connect to your Aprimo account and create a DataSet, you need the following:
  • Client ID and Client Secret
  • Domain name

​
Obtaining an Access Token

To obtain an access token, register an Aprimo Client within the platform’s administrative interface, navigating to Administration > Integration > Registrations. During the registration process, define the following required client parameters and authentication flow:
  • Client Name: A descriptive identifier for the registration.
  • Description: The stated purpose for the registration’s existence and use.
  • Client Secret: A permanent, confidential key generated during registration. Ensure to store this client secret securely .
  • Redirect URL: Mandatory if utilizing the Authorization Code flow.

​
OAuth Flow Type Selection

Select one of the following OAuth flow types based on the client’s operational requirements:
OAuth Flow Type Recommended Use Case
Authorization Code (PKCE) Recommended for interactive auth flows.
Client Credentials Use for service-based API calls.
Resource Owner Password Scenarios requiring multiple user authentications without a browser-based login interface.

​
Register the Client Application

Register a client application for the Client Credentials OAuth 2.0 flow to retrieve an API token for backend service calls. The token operates under the permissions of a specified integration user.
  1. Navigate to Administration > Integration > Registrations in Productivity Management.
  2. Click New.
  3. Set the OAuth Flow Type to Client Credentials.
  4. Set the User field to the user whose permissions the API calls will use. (This user is the sole context for the registration.)
  5. Set the Access Token Lifetime (1 to 60 minutes).
  6. Securely store the generated Client Secret; it cannot be retrieved later.
  7. Click Save.
Note: Allow up to 15 minutes for registrations to update.

​
Connecting to Your Aprimo Account

This section enumerates the options in the Credentials and Details panes on the Aprimo Connector page. The components of the other panes on this page, Scheduling, and Name & Describe Your DataSet, are universal across most connector types and are discussed in great detail in Adding a DataSet Using a Connector.

​
Credentials Pane

This pane contains fields for entering credentials to connect to your Aprimo account. The following table describes what is needed for each field:

Field

Description

Client ID Enter the customer’s Client ID. To obtain the client ID, refer to the API documentation or refer to the Prerequisites section.
Client Secret Enter the customer’s Client Secret. To obtain the client Secret, refer to the API documentation or refer to the Prerequisites section.
Domain Enter the domain name associated with the Aprimo account.
Once you have entered valid Aprimo credentials, you can use the same account at any time to create a new Aprimo DataSet. You can manage connector accounts in the Accounts tab in the Data Center. For more information about this tab, see Manage Connector Accounts.

​
Details Pane

Menu

Description

Report

Select the Aprimo report you want to run. The following reports are available:

Report Name Description

Analytics Report

Retrieves the data about your analytics report.

Get All Classifications

Retrieves the data about your classifications.

Get All Groups

Retrieves the data about your groups.

Get Record Details

Retrieves the data about your record details.

Get All Records

Retrieves the data about your records.

Get User Details

Retrieves the data about your user details.

Reporting API

Retrieves the data about your reporting API.
Record Id Selection Criteria

This field appears when you select the Get Record Details report.

You fetch the record details of all the record IDs or select specific record IDs.

  • All Record IDs
  • Select Record IDs
Record IDs

This field appears when you select the Select Record IDs option from the Record Id Selection Criteria drop-down, and the report should be Get Record Details .

Select the record IDs to be included in the report.

User Id Selection Criteria

This field appears when you select the Get User Details report.

Use this option to retrieve the user details of all user IDs or specific user IDs.

  • All User IDs
  • Select User IDs
User IDs

This field appears when you select the Select User IDs option from the User Id Selection Criteria drop-down, and the report should be Get User Details .

Select the user IDs to fetch the user details.

Data Domain

This field appears when you select the Analytics Report .

Select the analytics data domain to determine the measures that should populate.

Measures

This field appears when you select the Analytics Report and select any Data Domain.

Select the measures (metrics) to include in the analytics report.

Dimensions

This field appears when you select the Analytics Report and select any Data Domain.

Select the dimensions (grouping fields) to include in the analytics report.

Report ID

This field appears when you select the Reporting API report.

Enter the unique identifier for the report execution.

Date Range

This field appears when you select the Reporting API report.

Choose whether the report should cover a Single Date or a Date Range .

  • Single Date: Select whether the report data is for a specific date or for a relative number of days back from today.
    • Relative Date: Enter the number of days back from today.
      • Days Back: Enter the number of days relative to today for which you want to receive the data. Use 0 for today, 1 for yesterday, 7 for 7days ago, and so on.
    • Specific Date: Use the date picker to select a precise date.
      • Date: Select the precise date. (The date cannot be before January 1, 2020, and must not be a future date.)

  • Date Range: Select the date range for which you want to fetch the data. The date range cannot be before January 1, 2020, and must not be a future date.

    • Start Date: Select the start date to fetch the data.

      • Relative Date: Enter the number of days back from today.
        • Days Back: Enter the number of days relative to today for the desired start date. For example, enter 1 for yesterday, 7 for 1 week ago, or 30 for 1 month ago.
      • Specific Date: Use the date picker to select a precise start date.
        • Date: Select the precise start date. (The date cannot be before January 1, 2020, and must not be a future date.)

    • End Date: Select the end date to fetch the data.

      • Relative Date: Enter the number of days back from today.
        • Days Back: Enter the number of days relative to today for the desired end date. For example, enter 0 for today, or 1 for an end date of yesterday.
      • Specific Date: Use the date picker to select a precise end date.
        • Date: Select the precise end date. (The date cannot be before January 1, 2020, and must not be a future date.)
  • Time Period: Select the time period for data retrieval.

​
Other Panes

For information about the remaining sections of the connector interface, including how to configure scheduling, retry, and update options, see Adding a DataSet Using a Connector.