Session Labels

Applying Session Tracking Labels to Agents on the Dashboard

You can apply an optional session tracking label to your agent, such as the name and version of your Content Management System (CMS), on the Manage Ingest page of the Agent Configuration Dashboard. The maximum number of characters in the label is 48, and only alphanumeric characters, periods, underscores and hyphens are allowed (a-z, A-Z, 0-9, . , _ and - ). Type the label in the CMS Name and Version box; for example:

Once the agent is saved and starts ingesting content, the tracking label is assigned to any Media API session that the agent is working with and maintained on the session when the agent gets the next set of content. The label appears in the session_label property value in the response; for example:

Labeling a Session Using a Request URL Parameter   

If you are making API calls using your own client application, you can label a session by adding the session_label={yourLabel} parameter to your feed, search or OnDemand request URL. The maximum number of characters in the label is 48, and only alphanumeric characters, periods, underscores and hyphens are allowed (a-z, A-Z, 0-9, . , _ and - ).

Example

Make sure to supply the API key in the x-api-key request header:

https://api.ap.org/media/v/content/feed?include=*&session_label=WordPress_v5.7

The session is created for you when you make an initial request. The label appears in the session_label property value in the response:

All links returned in that first response are considered to belong to the same session. To maintain that session, you must use the returned "next_page" link to get the next set of content. If an item metadata link is followed from a labeled feed or search response, the item metadata response will also include the session_label property.