Step 1: Using the Catalog Endpoint

To use the Analytics API Catalog you can make a GET request to the following endpoint:


GET	https://api.yextapis.com/v2/accounts/me/analytics/catalog?api_key{YOUR_API_KEY}&v=20210415

Note: This endpoint requires a V parameter greater than or equal to 20210415.

The metrics returned from the Analytics API Catalog will depend on the Products you’ve purchased and have access to within the Platform.

Below is a sample output of how data is returned via the Analytics Catalog endpoint today:

{
    "meta": {
        "uuid": "88968fc0-ef3d-44c8-8a50-a3dadd059334",
        "errors": []
    },
    "response": {
        "metrics": [
            {
                "id": "BING_SEARCHES",
                "completedDate": "2021-03-14"
            },
            {
                "id": "FACEBOOK_POST_IMPRESSIONS",
                "completedDate": "2021-03-22"
            },
            {
                "id": "GOOGLE_SEARCH_VIEWS",
                "completedDate": "2021-03-24"
            }
        ]
    }
}

Here you can see each of the metrics available for the account (e.g. BING_SEARCHES, FACEBOOK_POST_IMPRESSIONS AND GOOGLE_SEARCH_VIEWS) along with their corresponding Completed Date.

Feedback

<% elem.innerText %>