Platform Data Dictionary | Yext Hitchhikers Platform

Use these views to get a log of your Content Delivery and Management API requests, as well as other platform resource usage.

API Requests

platform.api_requests

This view contains a log of all API requests for Management APIs. There is a 30-day lookback period for API requests, rather than the standard one year lookback for fact tables.

Sample Queries

Get all Management API requests and associated metadata for the past seven days.

select 
    uuid,
    request_timestamp,
    app_id,
    endpoint_id,
    status_code,
    request_url,
    request_body,
    duration_milliseconds,
    response_body,
    errors
from platform.api_requests
where date(request_timestamp) > dateadd(day, -8, current_date)

Apps

platform.apps

This view contains information about your Yext developer apps. This can be used to decode the app_id column in other platform views.

Sample Queries

Get all consumer API calls from the last 7 days, using the apps view to decode which apps made the requests.

select 
    uuid,
    request_timestamp,
    consumer_api_requests.app_id,
    apps.display_name
    endpoint_id,
    status_code,
    request_url,
    request_body,
    duration_milliseconds,
    response_body,
    errors
from platform.consumer_api_requests
join platform.apps using (app_id)
where date(request_timestamp) > dateadd(day, -8, current_date)

Consumer API Requests

platform.consumer_api_requests

This view contains a log of all API requests for Content Delivery and other consumer-facing APIs. There is a 30-day lookback period for API requests.

Sample Queries

Get all Content Delivery API requests that received a 404 status code for the past seven days.

select 
    uuid,
    request_timestamp,
    app_id,
    endpoint_id,
    request_url,
    request_body,
    duration_milliseconds,
    response_body,
    errors
from platform.consumer_api_requests
where date(request_timestamp) > dateadd(day, -8, current_date)
and status_code = 404

Endpoints

platform.endpoints

This view contains all Yext API endpoint IDs and their names, meant to be used for decoding the endpoint_ID column in other platform views.

Sample Queries

Get a count of all Management API calls from the last 7 days by endpoint, using the endpoints view to decode which endpoints these requests were sent to.

select 
    api_requests.endpoint_id,
    endpoints.name,
    count(*)
from platform.api_requests
join platform.endpoints using (endpoint_id)
where date(request_timestamp) > dateadd(day, -8, current_date)
group by 1,2 order by 3 desc

Function Invocations

platform.function_invocations

This view contains a log history of function invocations associated with plugins. It can be useful as an audit log for performance tracking purposes.

Sample Queries

Get a log of all function invocations for a given plugin today. Add a where clause to filter the results to a given plugin ID.

select 
    businesses.business_id, 
    name,
    invocation_timestamp, 
    plugin_external_id,
    argument_json, 
    logs, 
    case 
        when error is not null then 'FAILED'
        else 'SUCCESS'
    end as status, -- Indicate whether an invocation succeeded or failed based on the error message
    caller_type,
    error 
from logs.function_invocations 
join public.businesses using (business_id)
where plugin_external_id like '%somePluginName%'
and invocation_timestamp > current_date()
order by 3 desc;