How to use this site

This topic is about the Amperity documentation site and describes the topic collections that are here and the features that help you find what you are looking for.

The numbers in the following images refer to specific areas within the documentation that enable:

1. Site navigation

2. Cross-site search

3. Left-side navigation

4. Topic pane

5. Right-side navigation

6. Feedback

On a tablet or mobile device, site navigation, search, and left-side navigation moves to the menu in the top-right corner. (The right-side navigation is not available when viewing the documentation from a tablet or mobile device.) Click the menu to search, browse the left-side navigation, and switch between the User Guides, Operators Guide, API, and Amperity A-Z topic collections.

Site navigation

The site navigation runs across the top of the site and links together five topic collections. From left to right:

1. Click the Amperity Documentation logo to return to a collection of overview topics.

2. Click User Guides for information about AmpAI, building segments that define high value audiences, and then sending those audiences to various marketing channels to support any type of marketing campaign.

3. Click Operators Guide for information about configuring Amperity for your tenant.

4. Click API for information about Amperity API endpoints. (You can learn more about the Profile API and Streaming Ingest API from the Operators Guide.)

5. Click Amperity A-Z to open a topic collection that describes every aspect of Amperity.

6. Click the icon for information about the latest features and improvements to Amperity.

Cross-site search

Cross-site search enables a single interface that returns results for all topics in all topic collections.

Synonyms are applied to search results to associate commonly used search terms to the right topics. For example: “SFMC” is a synonym for “Salesforce Marketing Cloud” and a search for either will return the same result.

A naming pattern is used to help you recognize reference content and user-focused content within the search results:

• Topics in the Amperity A-Z collection start with “About”, such as “About Couriers” or “About Semantic Tags”.

• Topics in the User Guides and Operators Guide topic collections start with verbs, such as “Manage Databases”, “Send Query Results”, and “Build Campaigns”.

On a tablet or mobile device, search is available from the menu in the top-right corner. Click that menu to open the navigation, and then the search box is located at the top of that menu.

Left-side navigation

The left-side navigation represents all of the topics within a topic collection and is organized in a way that keeps similar topics close together, either by component or by workflow.

• User Guides describe marketer activities, such as building audiences (using segments and segment insights), and then configuring those audiences to be part of campaigns that support a variety of marketing channels, use cases, and outcomes and analytics, along with analytics activities like building queries, and then sending the results to downstream workflows and BI tools.

• Operators Guide describes how to configure Amperity to support your brand’s use cases.

• Amperity A-Z is organized alphabetically.

On a tablet or mobile device, the left-side navigation is available from the menu in the top-right corner. Click that menu to open the navigation, and then browse through the sections.

Topic pane

The topic pane contains all of the content. The right-side navigation shows the structure of the topic. For example, a topic titled “About Couriers” contains all of the information about couriers and a topic titled “Send to Klaviyo” contains all of the information about sending query results to Klaviyo from Amperity.

Some topics are very long, like the Presto SQL and Spark SQL reference topics. All topics are complete based on the title of the topic. Use your browser’s finder window to search within large topics for keywords as necessary.

Right-side navigation

The right-side navigation represents the sections within the current topic and is generated automatically based on the headers within the topic. For many topics only the title is represented within the left-side navigation.

On a tablet or mobile device, the right-side navigation is not available, though any anchor links will work correctly and will bring you to the right spot on the page.

Feedback

A feedback button is available in the lower right. Please use this button to send us feedback about Amperity documentation.

It’s easy to send documentation feedback:

1. Click the feedback button.

2. Type your feedback.

3. A valid email address is required. Provide your email address or use docs@amperity.com to send your feedback anonymously. We will review your feedback and quickly address all feedback.

   Important

   If you have a genuine support issue, please click the Get Support link in the site navigation (at the top), and then follow the directions listed there, or contact your Amperity representative directly.

4. Send your feedback. Thank you!

On a tablet or mobile device, the feedback button remains in the lower right of the window.