loading

Reports

Create a report to retrieve analytics for each of your products using synchronous or asynchronous requests depending on the size of your data.

path Parameters
accountId
required
string
query Parameters
v
required
string

A date in YYYYMMDD format.

async
boolean

Defaults to false. When true, the report’s ID will be returned immediately and the report results can be fetched later. When false, the report results will be returned immediately, but an error may occur if the data requested is too large.

callback
string

Optional. When async=true and callback is specified, the provided URL will be called when the report is ready. The URL must be of the form:

POST https://[your domain]/[your path]

It must accept the following parameters:

id:         (string)  - The ID of the report request which completed.

status:     (string)  - One of [DONE, FAILED] indicating the result of the request.

statusCode: (int)     - An HTTP status code indicating the result of the request.

message:    (string)  - When status=FAILED, contains an error message.

url:        (string)  - When status=DONE, contains the URL to download the report data as a text file.
Request Body schema: application/json

JSON object containing any filters to be applied to the report

metrics
required
Array of strings

The kinds of data the report should include. Specify up to 10 values.

  • ANSWERS_CASE_DEFLECTIONS: The number of times a user started their journey but did not create a case.
  • ANSWERS_CASE_DEFLECTION_RATE: Percentage of cases that were deflected by Support Search.
  • ANSWERS_CASE_STARTS: The number of times a user started their journey with search.
  • ANSWERS_CASE_SUBMITS: The number of times a user started their journey with search and submitted a case.
  • ANSWERS_CLICKS: Number of times content has been clicked.
  • ANSWERS_CLICK_THROUGH_RATE: Percentage of Searches with a click, rounded to the 1’s place, e.g. 67.96% → 68%. CTR = Searches with Click / Searches.
  • ANSWERS_CLUSTERS: Distinct count of Clusters.
  • ANSWERS_KG_RESULT_RATE: Percentage of Searches where a Knowledge Graph Result was returned.
  • ANSWERS_PERCENTAGE_OF_TOTAL_SEARCHES: Percentage of Answers Searches a given dimension(s) represents based on the dimension(s) and filter(s) selected e.g. Percentage of Searches by Search Term where Version Label = PRODUCTION.
  • ANSWERS_SEARCHES: Number of times a user ran a Search.
  • ANSWERS_SEARCHES_WITH_CLICKS: Number of times a user ran a Search and clicked a link.
  • ANSWERS_SEARCHES_WITH_KG_RESULTS: Number of times a user ran a Search that returned Knowledge Graph Results.
  • ANSWERS_SEARCH_TERMS: Distinct count of Search Terms.
  • ANSWERS_SESSIONS: Number of times a Session was started. A Session begins on user’s first search and ends when user closes the browser.
  • AVERAGE_RATING: The cumulative average of the ratings your business has received.
  • BING_SEARCHES: The number of times your listings were included in Bing search results. Because Bing sends data for full weeks rather than individual days, dimensions cannot contain DAYS, MONTHS, or MONTHS_RETAIL if BING_SEARCHES is in metrics. Also, reports with BING_SEARCHES have different reporting maximum dates than reports with other metrics.
  • CLICKS: The number of times consumers clicked on your online properties.
  • CONVERSIONS: The number of conversions based on the methodology you selected.
  • CONVERSION_RATE: Conversions divided by clicks.
  • CONVERSION_SEARCHES: Number of Answers Searches with a Click.
  • CONVERSION_VALUE: The monetary impact of your conversions.
  • CUMULATIVE_RATING: Average review rating of Competitors.
  • DUPLICATES_DETECTED: Count of all duplicates detected.
  • DUPLICATES_SUPPRESSED: Count of all duplicates suppressed.
  • EVENT_PROFILEVIEWS: The number of times a consumer has seen your full event listing profile on a publisher site, either by clicking on your event listing from a search on the publisher site or from another search engine.
  • EVENT_SEARCHES: The number of times a consumer has run a search and seen your event listing in the search result on a Yext Listings Publisher site.
  • FACEBOOK_CHECKINS: The total number of consumers who have checked into your business, along with the people tagged as being with them when checking in.
  • FACEBOOK_CTA_CLICKS: The total number of clicks on your Page CTA button by people who are logged in to Facebook.
  • FACEBOOK_EVENT_NEW_RSVPS: The number of new RSVPs to your Facebook event.
  • FACEBOOK_IMPRESSIONS: The total number of impressions seen of any content associated with your Page.
  • FACEBOOK_LIKES: The number of consumers who have "liked" your Page.
  • FACEBOOK_PAGE_VIEWS: The total number of times your Page has been viewed.
  • FACEBOOK_POST_IMPRESSIONS: The number of impressions for your Page post.
  • FACEBOOK_TALKING_ABOUT: The number of unique consumers who had an interaction with your Page. For an interaction to be included in this total, it must result in a story being posted to the newsfeeds of those consumers' friends. Examples of these interactions include, but are not limited to, sharing a post on your Page, liking your Page, or tagging your location in a photo.
  • FACEBOOK_WERE_HERE: The total number of consumers who have checked into your business on Facebook, along with the people tagged as being with them when checking in.
  • FEATURED_MESSAGE_CLICKS: The number of times consumers clicked on your Featured Messsage. Does not include Featured Messages on Yelp, Facebook, Bing, or Google.
  • FOURSQUARE_DAILY_CHECKINS: The number of consumers who checked into your business on Foursquare on a given date.
  • GOOGLE_CUSTOMER_ACTIONS: The number of times consumers called your business, got driving directions to your business, or visited your website via the links in your Google listings.
  • GOOGLE_MAP_VIEWS: The number of times your listings were viewed on Google Maps.
  • GOOGLE_PHONE_CALLS: The number of times consumers called your business by clicking your phone number in your Google listings during the past 90 days. You must use the GOOGLE_PHONE_CALL_HOURS dimension with this metric.
  • GOOGLE_SEARCH_QUERIES: The number of times your listings appeared in search results on either Google Search or Google Maps.
  • GOOGLE_SEARCH_VIEWS: The number of times your listings were viewed on Google Search.
  • GOOGLE_USER_PHOTOS: The number of photos uploaded by Google users (consumers) to your Google listing.
  • INSTAGRAM_POSTS: NOTE: This metric is deprecated. The number of times consumers posted Instagram content geotagged at your business.
  • IST_AD_MATCHES: The total number of ads matched to the location or one of its competitors.
  • IST_AD_PRESENCE: The percentage of searches in which at least one ad appeared for the location or one of its competitors.
  • IST_AVERAGE_FIRST_LOCAL_PACK_MATCH_POSITION: The average position of the first match in the local pack in the search engine results page if one exists.
  • IST_AVERAGE_FIRST_MATCH_POSITION: The average position of the first match in either the local pack or organic results in the search engine results page if one exists.
  • IST_AVERAGE_FIRST_ORGANIC_MATCH_POSITION: The average position of the first match in the organic results in the search engine results page if one exists.
  • IST_AVERAGE_LOCAL_PACK_NUMBER_OF_RESULTS: The average number of results in the local pack when it appears in a search engine results page.
  • IST_AVERAGE_LOCAL_PACK_POSITION: The average position of the local pack when it appears in a search engine results page.
  • IST_KNOWLEDGE_CARD_EXISTED: The percentage of times a knowledge card showed up in search results.
  • IST_LOCAL_PACK_EXISTED: The percentage of times a local pack showed up in search results.
  • IST_LOCAL_PACK_PRESENCE: The percentage of times your business appears in a local pack when one was shown.
  • IST_LOCAL_PACK_SHARE_OF_SEARCH: The share of search for all local pack matches in the search engine results page.
  • IST_MATCHES_PER_SEARCH: The total number of matches on the first page of the search engine results.
  • IST_ORGANIC_SHARE_OF_SEARCH: The share of search for all organic matches in the search engine results page.
  • IST_SEARCH_REQUESTS: The number of search requests that were successfully analyzed.
  • IST_SHARE_OF_INTELLIGENT_SEARCH: The share of search for all matches in the search engine results page.
  • IST_TOTAL_MATCHES: The total number of matches on the first page of the search engine results.
  • KEYWORD_MENTIONS: The number of times a review keyword is mentioned.
  • KEYWORD_SENTIMENT: The sentiment score of review keywords.
  • LISTINGS_LIVE: Count of new listings live.
  • NEW_REVIEWS: The number of new reviews your business has received.
  • POWERLISTINGS_LIVE: The total number of your listings that were live.
  • PROFILE_UPDATES: Count of updates to your Yext profile.
  • PROFILE_VIEWS: The number of times your listings were viewed. Does not include listings on Yelp, Bing, or Google.
  • PUBLISHER_SUGGESTIONS: Count of all publisher suggestions.
  • RESPONSE_COUNT: The number of reviews with responses on publishers that support in-platform response.
  • RESPONSE_RATE: The percentage of reviews with responses on publishers that support in-platform response.
  • RESPONSE_TIME: The average time in hours between the review date and the response date of all reviews with responses that can be responded to in the platform.
  • SEARCHES: The number of times your listings were included in search results. Does not include search results on Yelp, Facebook, Bing, or Google.
  • SESSIONS: Number of Answers Sessions with a Click.
  • SOCIAL_ACTIVITIES: Count of all new social posts.
  • ST_EVENT_MATCHES_PER_SEARCH: Matches per Search for Events.
  • ST_EVENT_RICH_RESULT_PRESENCE: The percentage of time your event appeared in an event rich result when one was shown.
  • ST_EVENT_SHARE_OF_INTELLIGENT_SEARCH: Share of Intelligent Search for your Events.
  • STOREPAGES_CALLTOACTIONCLICKS: The number of times someone clicked a call to action on your Store Pages.
  • STOREPAGES_CLICKSTOWEBSITE: The number of times someone clicked to go to your website from your Store Pages.
  • STOREPAGES_DRIVINGDIRECTIONS: The number of times someone clicked for directions on your Store Pages.
  • STOREPAGES_EVENT_eventtype: The number of times the Store Pages custom event occurred. Replace "eventtype" with the custom event name.
  • STOREPAGES_PAGEVIEWS: The number of page views on your Store Pages.
  • STOREPAGES_PHONECALLS: The number of times someone clicked to make a phone call from your Store Pages.
  • STOREPAGES_SESSIONS: The number of unique visitors (sessions) to your Store Pages.
  • TICKET_CLICKS: Clicks to a button that allows users to get tickets.
  • VALUE_PER_CONVERSION: Total conversion value divided by the number of conversions.
  • WIDGETS_REVIEWS_VIEWS: The number of views of embedded 'widgets' containing reviews.
  • YELP_CUSTOMER_ACTIONS: The number of times consumers called your business, got driving directions to your business, or visited your website via the links in your Yelp listings.
  • YELP_PAGE_VIEWS: Number of times your listings on Yelp ("pages") were viewed.
dimensions
required
Array of strings

Determines how the data will be grouped. Specify up to 3 values.

NOTES:
You can only use one time-based dimension (e.g., DAYS, WEEKS) per report.
You can only use one location-based dimenion (e.g., FOLDER_IDS, LOCATION_NAMES) per report.

  • ACCOUNT_IDS: Identify events by sub-account.
  • AGE: The age range of a Facebook user. Can be used with FACEBOOK_LIKES, FACEBOOK_TALKING_ABOUT, FACEBOOK_CHECKINS, FACEBOOK_IMPRESSIONS, and FACEBOOK_PAGE_VIEWS.
  • ANSWERS_BACKEND: Backend(s) used to return results. Currently includes:
    • Algolia
    • Bing CSE
    • Custom Covid Backend
    • Knowledge Manager
    • Google CSE
    • Zendesk
    Can only be used with Answers metrics.
  • ANSWERS_BLANK_SEARCH_TERM: Indicates whether no Search Term was entered for Search.
  • ANSWERS_CLICK_LABEL: Label assigned to CTA_CLICK types.
  • ANSWERS_CLICK_TYPE: Type of Click. Can only be used with Answers metrics.
  • ANSWERS_CLICK_URL: URL user was sent to on click, e.g. Google Maps on Driving Directions click.
  • ANSWERS_CLUSTER: Name of the Cluster a Search Term belongs to. Search Term Clusters are named by using the most popular Search Term (based on Sessions) within the Cluster.
  • ANSWERS_CONFIGURATION_VERSION: Version Number of Configuration used to run the Search. Can only be used with Answers metrics.
  • ANSWERS_CONFIGURATION_VERSION_LABEL: Version Label of Configuration used to run the Search. Can only be used with Answers metrics.
  • ANSWERS_DIRECT_ANSWER_CLICK: Indicates whether a click was from Direct Answer.
  • ANSWERS_DIRECT_ANSWER_FIELD: Field returned in Direct Answer.
  • ANSWERS_DIRECT_ANSWER_FIELD_VALUE: Value returned in Direct Answer.
  • ANSWERS_EXPERIENCE: Name of Answers Experience. Can only be used with Answers metrics.
  • ANSWERS_EXPERIENCE_KEY: Key of Answers Experience. Can only be used with Answers metrics.
  • ANSWERS_HAS_KG_RESULTS: Include only searches with results from the Knowledge Graph.
  • ANSWERS_HAS_SEARCH_TERM_CLUSTER: Indicates whether a Search Term belongs to a Search Term Cluster. Search Terms may not belong to a cluster if they do not pertain to any other terms searched on your experience or if it is a new term that has been searched for the first time since clustering was last run.
  • ANSWERS_LOCALE: Locale Search was run in. Can only be used with Answers metrics.
  • ANSWERS_QUERY_SOURCE: The integration source from which this search originated. This includes the following options: STANDARD (standard search bar) and OVERLAY (within an search overlay).
  • ANSWERS_RAW_SEARCH_TERM: Raw Search Term entered by user for Search.
  • ANSWERS_REFERRER_DOMAIN: Domain of page where user was sent from, e.g. jobs.mysite.com.
  • ANSWERS_REFERRER_PAGE_URL: URL of page where user was sent from, e.g. https://jobs.mysite.com/careers/open-positions/.
  • ANSWERS_RESULT_ENTITY_POSITION: Position Entity was returned within Vertical.
  • ANSWERS_RESULT_TITLE: Title of Result from Third Party Backends. For results that come from Knowledge Graph backends this will be blank.
  • ANSWERS_RESULT_VERTICAL_POSITION: Position of Verticals in Result.
  • ANSWERS_SEARCH_ID: ID of Search. Can only be used with Answers metrics.
  • ANSWERS_SEARCH_TERM: Normalized Search Term of Search. Normalization removes:
    • Capitalization
    • Punctuation
    • White Space
    Can only be used with Answers metrics.
  • ANSWERS_SEARCH_TERM_CLUSTER_PERFORMANCE: Identify how well a cluster is performing based on % of Total Searches and Click Through Rate. Cluster Performance breaks down into four groups: Needs Attention - Large Cluster, Needs Attention - Small Cluster, Performing Well - Small Cluster and Performing Well - Large Cluster.
  • ANSWERS_SEARCH_TERM_INTENT: Whether Search Term should be boosted or blacklisted based on your experience config. Options include BOOSTED and BLACKLISTED.
  • ANSWERS_SEARCH_VERTICAL: Vertical Search was ran on. Can only be used with Answers metrics.
  • ANSWERS_SESSION_ID: ID of Session Search was run in. Can only be used with Answers metrics.
  • ANSWERS_TRAFFIC_TYPE: External or Internal. Can only be used with Answers metrics.
  • ANSWERS_USER_CITY: City of user running Search.
  • ANSWERS_USER_COUNTRY: Country of user running Search.
  • ANSWERS_USER_DEVICE_CLASS: Device of user running Search.
  • ANSWERS_USER_LAT_LONG: Lat, Long of user running Search.
  • ANSWERS_USER_LOCATION_ACCURACY: Method for identifying user location. Options include Unknown, Device, and IP.
  • ANSWERS_VERSION_LABEL: The Configuration Version Label of the Answers clicks or conversions.
  • CLICK_TYPE: Identify the type of click that a conversion is attributed to. Can only be used with Conversion Tracking metrics.
  • CONVERSION_ACTION_ID: Can only be used with Conversion Tracking metrics.
  • CONVERSION_TYPE: Type of conversion action (Customer Support, Lead, Page View, Purchase, etc).
  • CUSTOMER_ACTION_TYPE: The type of action consumers took through your Google or Yelp listings (Phone Calls, Get Directions, or Website Clicks). Can only be used with the GOOGLE_CUSTOMER_ACTIONS and YELP_CUSTOMER_ACTIONS metrics. Replaces GOOGLE_ACTION_TYPE for v parameters 20170914 and later.
  • DAYS: Identify events by day.
  • DAY_OF_WEEK Identify events by day of the week (Monday, Tuesday, etc.).
  • ENTITY_GROUPS Identify events by the type group of the corresponding entity.
  • ENTITY_IDS Identify events by the corresponding entity.
  • ENTITY_TYPES Identify events by the type of the corresponding entity.
  • EVENTS Identify events by the corresponding event.
  • EVENT_SEARCH_CONDITION: Identify Search Tracker for Events metrics by the event search schedule condition. Can be used with Search Tracker Event metrics.
  • FACEBOOK_IMPRESSION_TYPE: Indicates whether your Facebook Impressions came from Organic, Paid, or Viral content. Can only be used with the FACEBOOK_IMPRESSIONS and FACEBOOK_POST_IMPRESSIONS metrics.
  • FACEBOOK_RSVP_TYPE: Identify Facebook Events by RSVP type. Can be used with FACEBOOK_EVENT_NEW_RSVPS.
  • FACEBOOK_STORY_TYPE: How people are talking about your Page (e.g., posts, likes, comments). Can only be used with the FACEBOOK_TALKING_ABOUT metric.
  • FIELD_NAME: The name of the field being updated in your profile (can only be used with the PROFILE_UPDATES metric).
  • FOLDER_IDS: Identify events by folder ID of the corresponding entity.
  • FOLDER_NAMES: Identify events by folder name of the corresponding entity.
  • FOURSQUARE_AGE: Groups checkins by the users' ages (13-17, 18-24, 25-34, 35-44, 45-54, 55+). Can only be used with the FOURSQUARE_DAILY_CHECKINS metric.
  • FOURSQUARE_GENDER: Groups checkins by users' sexes (male or female). Can only be used with the FOURSQUARE_DAILY_CHECKINS metric.
  • FOURSQUARE_TIME: Groups checkins by their times (morning: 7 AM - 10:59 AM, noon: 11 AM - 1:59 PM, afternoon: 2 PM - 5:59 PM, evening: 6 PM - 8:59 PM, night: 9 PM - 6:59 AM). Can only be used with the FOURSQUARE_DAILY_CHECKINS metric.
  • FREQUENT_WORDS: The words that most frequently appear in your reviews.
  • GENDER: The gender of a Facebook user. Can be used with FACEBOOK_LIKES, FACEBOOK_TALKING_ABOUT, FACEBOOK_CHECKINS, FACEBOOK_IMPRESSIONS, and FACEBOOK_PAGE_VIEWS.
  • GOOGLE_ACTION_TYPE: The type of action consumers took through your Google listings (Phone Calls, Get Directions, or Website Clicks). Can only be used with the GOOGLE_CUSTOMER_ACTIONS metric. Only works with v parameters before 20170914.
  • GOOGLE_PHONE_CALL_HOURS: Can only be used with the GOOGLE_PHONE_CALLS metric.
  • GOOGLE_QUERY_TYPE: Groups search criteria based on whether they contained your brand name (branded) or not (unbranded). Can only be used with the GOOGLE_SEARCH_QUERIES metric. If the v parameter is before 20171020: groupings are BRANDED QUERIES and UNBRANDED QUERIES, otherwise groupings are DIRECT and DISCOVERY. If the v parameter is 20190425 or later: a new query type BRANDED is added.
  • IST_COMPETITOR: Competitors monitored by the Intelligent Search Tracker. Can be used with Intelligent Search Tracker metrics and the Cumulative Rating metric.
  • IST_KEYWORD: The keyword used to create search requests. Can only be used with Intelligent Search Tracker metrics.
  • IST_LOCAL_PACK_COMPETITOR: Local pack competitors monitored by the Intelligent Search Tracker. Can be used with IST_MATCHES_PER_SEARCH and IST_TOTAL_MATCHES.
  • IST_MATCH_POSITION: The local pack or organic position of the search result. Can only be used with Intelligent Search Tracker metrics.
  • IST_MATCH_TYPE: One of Local Map Pack, Listings, Pages and Corporate Website. Can only be used with Intelligent Search Tracker metrics.
  • IST_QUERY_TEMPLATE: The query template used to create search requests. Can only be used with Intelligent Search Tracker metrics.
  • IST_SEARCH_ENGINE: The search engine used for the Intelligent Search Tracker. Can only be used with Intelligent Search Tracker metrics.
  • IST_SEARCH_RESULT_TYPE: One of Organic, Local Pack or Knowledge Card. Can only be used with Intelligent Search Tracker metrics.
  • LISTINGS_LIVE_TYPE: The type of of listings live, either be Claimed or Created (can only be used with LISTINGS_LIVE metric).
  • LOCATION_IDS: Identify events by store ID of the corresponding location.
  • LOCATION_NAMES: Identify events by name of the corresponding location.
  • MEDIUM_ID: Identify the source of click this conversion is attributed to. Can only be used with Conversion Tracking metrics.
  • MEDIUM_TYPE: Identify the type of source of click this conversion is attributed to. Can only be used with Conversion Tracking metrics.
  • MONTHS: Identify events by months of the Gregorian calendar (January, February, etc.).
  • MONTHS_RETAIL: Identify events by retail month. Refers to the 4-5-4 merchandising calendar.
  • PARTNERS: The sites your reviews appear on. Can only be used with Reviews metrics.
  • PLATFORM: Groups data by the platform on which the action measured in metrics was conducted (e.g., Desktop, Mobile).
  • QUARTERS: Identify events by quarter. Only supported for Review metrics.
  • PRODUCT: Identify conversion analytics by the product in which they occurred. Can only be used with Conversion Tracking metrics.
  • PUBLISHERS: Groups data about the site-interaction events listed in metrics by the sites on which they occurred.
  • PUBLISHER_SUGGESTION_TYPE: The type of the publisher suggestion (can only be used with the PUBLISHER_SUGGESTIONS metric).
  • RATINGS: Can only be used with Reviews metrics except CUMULATIVE_RATING.
  • REVIEW_KEYWORDS: The keywords used in your reviews.
  • REVIEW_LABELS: Identify reviews by their label.
  • SEARCH_QUERY: Groups searches according to the search criteria used. Can only be used with the SEARCHES metric.
  • SEARCH_TERM: Raw Search Term entered by user for Search.
  • SENTIMENT_COLLECTION: Identify reviews by their sentiment collection of keywords.
  • STOREPAGES_DIRECTORY: The directories of your Store Pages. Can only be used with Store Pages metrics.
  • STOREPAGES_PAGE_TYPE: The page types for your Store Pages. Can only be used with Store Pages metrics.
  • STOREPAGES_PAGE_URL: The urls people visited on your Store Pages. Can only be used with Store Pages metrics.
  • TRAFFIC_SOURCE: Identify conversion analytics by the source of the traffic.
  • VALUE_PROPOSITION: Value Proposition.
  • VERTICAL_CONFIG_ID: Vertical Config ID.
  • WEEKS: Identify events by week. A weeks is always Monday to Sunday, and is labeled with the date corresponding to the first day of that week.
  • WEEK_NUMBER A given week labeled with the number of weeks into a year and its corresponding year. A week is always Monday to Sunday, “Week 1” will always contain January 1st, and the year is the year of the last day (Sunday) of that week (Week 1 (2017), Week 2 (2017), etc.).
object

Responses

Request samples

Content type
application/json
{
  • "metrics": [
    ],
  • "dimensions": [
    ],
  • "filters": {
    }
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": {
    }
}