Editorial selection by Slug
Endpoint Overview
- Endpoint Name: Editorial selection by Slug
- Purpose: Retrieves the detail of a published custom entity for a specific culture, given its slug.
- Method: GET
- URL:
/{version}/content/{culture}/sel-{slug}
Authentication
- Authentication Type: None
Request
Headers
Header Name | Required | Description |
---|---|---|
accept | Yes | application/json |
Path Parameters
Parameter | Type | Description |
---|---|---|
version | string | The version of the API to be used. Allowed values: v2 . |
culture | string | The culture's identifier. E.g., en-us . |
slug | string | The language-specific identifier of the custom entity. |
Query Parameters
Parameter | Type | Required | Description |
---|---|---|---|
$skip | integer | No | The number of entities to be skipped. Default: 0 |
$limit | integer | No | The maximum number of entities to be returned (up to 100). Default : 25. |
Sorting
The only supported sorting is the default featured:descending and contentDate:descending . Specifying any other sorting condition will result in 400 (Bad Request) response.
Response
Response Codes
HTTP Status Code | Meaning |
---|---|
200 | Successful request |
404 | Not Found (resource does not exist) |
500 | Internal Server Error |
Response Body
Data structure
- meta: Contains general information related to the request performed (Object)
- apiVersion: The current version of the API endpoint that generated the response (String)
- generatedAt: The UTC timestamp of the response (String)
- pagination: Contains information about the pagination of the current response (Object)
- nextUrl: The URL that can be used to retrieve the next page of results (String)
- previousUrl: The URL that can be used to retrieve the previous page of results. This is only available when consuming a page next to the first one (String)
- maxItems: The maximum number of items that can be retrieved per page (100) (Integer)
- items: An array of entities object (
photo
,story
,album
,customentity
, etc.). Contract depends on the entity type. Please refer to the entity type page to read the full contract specification (Array)- type: The type of the entity (e.g.,
story
,photo
,album
,customentity
) (String) - _entityId: The language-independent unique identifier of the entity (Entity Code) (Guid)
- _translationId: The language-specific unique identifier of the entity (Localized Entity Code) (Guid)
- selfUrl: The URL to get the detail of this entity (String)
- slug: The unique identifier of this entity (String)
- title: The title of the item (String)
- contentDate: The UTC timestamp of this content (Date-time)
- createdBy: The full name of the author that created this entity (String)
- lastUpdatedBy: The full name of the last author that updated this entity (String)
- lastUpdatedDate: UTC timestamp of the last update operation occurred on this entity (Date-time)
- featured: When
1
, it represents a promoted content (Integer) - tags: An array of objects containing the set of tags related to this photo (Array)
- type:
tag
(String) - selfUrl: The URL to get the detail of the tag entity (String)
- slug: The language-specific unique identifier of the tag bound to the photo (String)
- neutralSlug: The language-independent unique identifier of the tag bound to the photo (String)
- externalSourceName: The name of the external source from where the tag was selected. If null, the tag is of type free-text (String)
- title: The title of the tag in the current language (String)
- extraData: An object containing custom-defined data, bound to the current tag (Object)
- fields: An object representing the available custom fields for the tag (Object)
- type:
- context: An object containing the information related to the tag used as the context (same contract as
tag
) (Object) - thumbnail: An object representing the thumbnail of the picture bound to the current item (Object)
- title: The title of the photo (String)
- templateUrl: The template URL that can be used to retrieve the photo from Cloudinary (String). Contains
{formatName}
or{formatInstructions}
placeholders. (String) - thumbnailUrl: The URL of the thumbnail format that can be used to retrieve the photo from Cloudinary (String)
- format: The format of the original image (e.g., jpg, png, etc.) (String)
- overriddenFormats: An object representing details related to the custom cropping coordinates set for this photo, if present. Available only when the system is configured with the cropping option (Object)
- slug: The language-specific unique identifier of the photo entity used as the thumbnail (String)
- selfUrl: The URL to get the detail of this entity (String)
- fields: An object representing the available custom fields for this item (Object)
- type: The type of the entity (e.g.,
Successful Response Example
Request
GET https://acme.org/v2/content/en-us/sel-hp-promoted-content
Response
▼ "root": {
▼ "pagination": {
"maxItems": 100
}
▼ "meta": {
"apiVersion": "2.0"
"generatedAt": "2020-07-30T14:31:18.9922663Z"
}
▼ "items": [
▼ "0": {
"type": "story"
"_translationId": "cda96b37-9b64-43a9-a076-c06a962ddb69"
"_entityId": "e2a3d03f-f0a1-4319-aeca-3465f01bc7f4"
"selfUrl": "https://acme.org/v2/content/en-us/stories/leclerc-albon-and-russell-join-the-grid-for-this-weekend-s-f1-esports-virtual-gr"
"slug": "leclerc-albon-and-russell-join-the-grid-for-this-weekend-s-f1-esports-virtual-gr"
"title": "Leclerc, Albon and Russell join the grid for this weekend’s F1 Esports Virtual Grand Prix\r"
▼ "tags": [
▼ "0": {
"_translationId": "65c59a33-2651-4877-90e0-8dad96cb228a"
"_entityId": "73ffe37c-5d07-4fdf-8c0c-4fc9ea862436"
"selfUrl": "https://acme.org/v2/content/en-us/tags/charles-leclerc"
"title": "Charles Leclerc"
"slug": "charles-leclerc"
"neutralSlug": "charles-leclerc"
"externalSourceName": "customentity.drivers"
▼ "externalSourceReference": {
"SourceId": "57347380-bdbc-42e8-ad81-305c72a8da0b"
"SourceName": "customentity.drivers"
}
▼ "extraData": {
"countryCode": "MCO"
}
▼ "fields": {
}
}
]
"createdBy": "Frank Becker"
"lastUpdatedBy": "Frank Becker"
"lastUpdatedDate": "2020-06-08T13:52:49.857Z"
"contentDate": "2020-04-06T09:47:01.309Z"
▼ "context": {
"_translationId": "149d59e2-cb7e-4668-bd30-d90f4ef9909d"
"_entityId": "9e3bfa04-7dc4-4c94-bc06-2bb482c08c09"
"selfUrl": "https://acme.org/v2/content/en-us/tags/formula-1"
"title": "Formula 1"
"slug": "formula-1"
"neutralSlug": "formula-1"
▼ "externalSourceReference": {
}
▼ "fields": {
}
}
"featured": 0
"headline": "Current Formula 1 drivers Charles Leclerc, Alex Albon, George Russell, Lando Norris, Nicholas Latifi and Antonio Giovinazzi have all confirmed they will be on the grid for the second instalment of the F1 Esports Virtual Grand Prix series this weekend.\r"
"summary": "The six F1 stars will be joined by former driver Johnny Herbert, who finished 13th in the inaugural race in Bahrain, as well as a host of stars including England’s Cricket World Cup Winner, BBC Sports Personality of the Year and Red Bull athlete Ben Stokes.\r\nAnd it will be"
▼ "thumbnail": {
"title": "Virtual Grand Prix Cover"
"templateUrl": "https://images.acme.org/media/image/private/{formatInstructions}/forge/vhsacefgqv9wylgawvs1"
"thumbnailUrl": "https://images.acme.org/media/image/private/w_250,h_250,c_thumb,g_auto,q_auto,f_jpg/forge/vhsacefgqv9wylgawvs1"
"format": "jpg"
▼ "overriddenFormats": {
}
"slug": "image-x1545"
"selfUrl": "https://acme.org/v2/content/en-us/photos/image-x1545"
}
}
▼ "1": {
"type": "album"
"_translationId": "bf79588f-c85f-4c6c-ab8f-cbe24fc9c2b1"
"_entityId": "887518c6-a738-446e-a5e4-6ed8c42f3202"
"selfUrl": "https://acme.org/v2/content/en-us/albums/formula-1-ferrari"
"slug": "formula-1-ferrari"
"title": "Formula 1 - Ferrari"
▼ "tags": [
▼ "0": {
"_translationId": "32582b03-b447-4140-a81c-d3cc99870b4e"
"_entityId": "12165adf-f36b-414d-83ab-efcec6a8dd95"
"selfUrl": "https://acme.org/v2/content/en-us/tags/ferrari"
"title": "Ferrari"
"slug": "ferrari"
"neutralSlug": "ferrari"
▼ "externalSourceReference": {
}
▼ "fields": {
}
}
]
"createdBy": "Frank Becker"
"lastUpdatedBy": "Frank Becker"
"lastUpdatedDate": "2020-04-06T09:55:27.258Z"
"contentDate": "2020-04-06T09:43:26.739Z"
▼ "context": {
"_translationId": "149d59e2-cb7e-4668-bd30-d90f4ef9909d"
"_entityId": "9e3bfa04-7dc4-4c94-bc06-2bb482c08c09"
"selfUrl": "https://acme.org/v2/content/en-us/tags/formula-1"
"title": "Formula 1"
"slug": "formula-1"
"neutralSlug": "formula-1"
▼ "externalSourceReference": {
}
▼ "fields": {
}
}
"featured": 0
▼ "thumbnail": {
"title": "image"
"templateUrl": "https://images.acme.org/media/image/private/{formatInstructions}/forge/vndndv75hlfrebkwywgd"
"thumbnailUrl": "https://images.acme.org/media/image/private/w_250,h_250,c_thumb,g_auto,q_auto,f_jpg/forge/vndndv75hlfrebkwywgd"
"format": "png"
▼ "overriddenFormats": {
}
"slug": "image-x6273"
"selfUrl": "https://acme.org/v2/content/en-us/photos/image-x6273"
}
"description": ""
}
▼ "2": {
"type": "story"
"_translationId": "4cadc347-c2ed-44dd-a930-8bf988637ce3"
"_entityId": "e3928168-4b9d-46a9-bf04-874a278c6e53"
"selfUrl": "https://acme.org/v2/content/en-us/stories/do-say-don-t-say-your-quickfire-guide-to-ferrari-for-2020"
"slug": "do-say-don-t-say-your-quickfire-guide-to-ferrari-for-2020"
"title": "DO SAY, DON'T SAY: Your quickfire guide to Ferrari for 2020"
▼ "tags": [
]
"createdBy": "Frank Becker"
"lastUpdatedBy": "Frank Becker"
"lastUpdatedDate": "2020-04-06T09:44:26.546Z"
"contentDate": "2020-04-06T09:44:26.546Z"
▼ "context": {
"_translationId": "149d59e2-cb7e-4668-bd30-d90f4ef9909d"
"_entityId": "9e3bfa04-7dc4-4c94-bc06-2bb482c08c09"
"selfUrl": "https://acme.org/v2/content/en-us/tags/formula-1"
"title": "Formula 1"
"slug": "formula-1"
"neutralSlug": "formula-1"
▼ "externalSourceReference": {
}
▼ "fields": {
}
}
"featured": 0
"summary": "Your hopes for Ferrari in 2020 undoubtedly depend on whether you see them as the romantic leads of Formula 1’s story or its moustachioed-twirling pantomime villains. They’ve won the constructors’ championship 16 times – but the statistic that gets everyone in Maranello a little bit twitchy is that they’ve come"
▼ "thumbnail": {
"title": "image"
"templateUrl": "https://images.acme.org/media/image/private/{formatInstructions}/forge/vndndv75hlfrebkwywgd"
"thumbnailUrl": "https://images.acme.org/media/image/private/w_250,h_250,c_thumb,g_auto,q_auto,f_jpg/forge/vndndv75hlfrebkwywgd"
"format": "png"
▼ "overriddenFormats": {
}
"slug": "image-x6273"
"selfUrl": "https://acme.org/v2/content/en-us/photos/image-x6273"
}
}
▼ "3": {
"type": "customentity"
"_translationId": "298fe1ee-5c01-454d-874b-f746ea887c96"
"_entityId": "b88a5597-d38c-4f66-a629-8ac26fbe05e1"
"selfUrl": "https://acme.org/v2/content/en-us/youtubevideos/lewis-hamilton-a-letter-to-my-younger-self"
"slug": "lewis-hamilton-a-letter-to-my-younger-self"
"title": "Lewis Hamilton: A Letter To My Younger Self\r"
▼ "tags": [
▼ "0": {
"_translationId": "db580f17-0f46-4ac5-9165-fb720dcd5c33"
"_entityId": "2096d5db-69a0-4f1a-89b3-b250f1806ffb"
"selfUrl": "https://acme.org/v2/content/en-us/tags/lewis-hamilton"
"title": "Lewis Hamilton"
"slug": "lewis-hamilton"
"neutralSlug": "lewis-hamilton"
"externalSourceName": "customentity.drivers"
▼ "externalSourceReference": {
"SourceId": "51739175-0306-4115-b797-9af4f6fe90e8"
"SourceName": "customentity.drivers"
}
▼ "extraData": {
"countryCode": "GB"
}
▼ "fields": {
}
}
]
▼ "fields": {
"videoId": "SGjoJloluUE"
"description": "\"If I knew then what I know now...\" - Lewis Hamilton sits down and dishes out the advice he would give to his younger self upon entering Formula 1..."
}
"createdBy": "Frank Becker"
"lastUpdatedBy": "Frank Becker"
"lastUpdatedDate": "2020-04-06T09:36:11.78Z"
"contentDate": "2020-04-06T09:36:11.78Z"
▼ "context": {
"_translationId": "149d59e2-cb7e-4668-bd30-d90f4ef9909d"
"_entityId": "9e3bfa04-7dc4-4c94-bc06-2bb482c08c09"
"selfUrl": "https://acme.org/v2/content/en-us/tags/formula-1"
"title": "Formula 1"
"slug": "formula-1"
"neutralSlug": "formula-1"
▼ "externalSourceReference": {
}
▼ "fields": {
}
}
"featured": 0
"entityCode": "youtubevideo"
}
▼ "4": {
"type": "customentity"
"_translationId": "89e5ad84-83e4-4576-81ab-a7daca05aa08"
"_entityId": "83cf68fe-e69e-4bc1-86b9-37f7c00c1702"
"selfUrl": "https://acme.org/v2/content/en-us/youtubevideos/sebastian-vettel-s-top-10-radio-moments"
"slug": "sebastian-vettel-s-top-10-radio-moments"
"title": "Sebastian Vettel's Top 10 Radio Moments\r"
▼ "tags": [
▼ "0": {
"_translationId": "0d040436-da71-4273-88c3-73220acb73e6"
"_entityId": "b701ec7b-a52b-46ee-be89-f53d03fa2c81"
"selfUrl": "https://acme.org/v2/content/en-us/tags/sebastian-vettel"
"title": "Sebastian Vettel"
"slug": "sebastian-vettel"
"neutralSlug": "sebastian-vettel"
"externalSourceName": "customentity.drivers"
▼ "externalSourceReference": {
"SourceId": "5475eb41-d402-4b57-8771-1a303cb315df"
"SourceName": "customentity.drivers"
}
▼ "extraData": {
"countryCode": "GER"
}
▼ "fields": {
}
}
]
▼ "fields": {
"videoId": "mJbhmPZCy5o"
"description": "From his historic first win to his maiden championship title, and all the juicy bits in between - \"honestly\", the four-time world champion has uttered some great lines!"
}
"createdBy": "Frank Becker"
"lastUpdatedBy": "Frank Becker"
"lastUpdatedDate": "2020-04-06T09:35:09.547Z"
"contentDate": "2020-04-06T09:32:53.046Z"
▼ "context": {
"_translationId": "149d59e2-cb7e-4668-bd30-d90f4ef9909d"
"_entityId": "9e3bfa04-7dc4-4c94-bc06-2bb482c08c09"
"selfUrl": "https://acme.org/v2/content/en-us/tags/formula-1"
"title": "formula-1"
"slug": "formula-1"
"neutralSlug": "formula-1"
▼ "externalSourceReference": {
}
▼ "fields": {
}
}
"featured": 0
"entityCode": "youtubevideo"
}
]
}
Error Response Example
{
"type": "https://tools.ietf.org/html/rfc9110#section-15.5.5",
"title": "Not Found",
"status": 404,
"traceId": "00-bdd418da1652593248958acf2dfad4e0-6d55da45f17bddf1-00"
}
Common Errors and Troubleshooting
Nothing known.
Related Endpoints
...