Content Portal API

GET content/search

Search content. WARNING: content search is basically a beta feature at this point. At the moment, search queries match on content name and that's it. Options exist to control paging behavior.

Examples

Simple
Paging

GET /api/v1/content/search?q=Phoenix HTTP/1.1
Accept: application/json
----------------------------------------
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
ETag: ...

{
  "items": [{
    "id": "350175ae-96ab-4843-8abf-0b59fd7969b8",
    "listingId": 177,
    "revisionId": "19548699-06fd-4c12-b2ca-29040291288e",
    "authorUsername": "tcoles+test01",
    "authorAvatar": "protected/us-west-2:5f40aa7b-817d-4a9d-a92f-5cbfad3e6dc2/ec9fbd31-d78a-44ac-8566-3500cd1953bc.jpg",
    "authorEmblem": "064a4b8d-4b42-4d9b-b5e6-da6dadd2026e",
    "type": "game",
    "status": "active",
    "name": "Phoenix 491",
    "thumbnailUri": "protected/us-west-2:5f40aa7b-817d-4a9d-a92f-5cbfad3e6dc2/b31ac216-4c5b-4413-b3d0-e8a8dee96ed7.jpg",
    "featured": false,
    "rating": "1"
  },
  {
    "id": "2a6c03a8-36a8-4ffa-ac38-6d5a08285ab8",
    "listingId": 185,
    "revisionId": "1ccea725-4111-4503-a4d5-1002a61405c0",
    "authorUsername": "tcoles+test01",
    "authorAvatar": "protected/us-west-2:5f40aa7b-817d-4a9d-a92f-5cbfad3e6dc2/ec9fbd31-d78a-44ac-8566-3500cd1953bc.jpg",
    "authorEmblem": "064a4b8d-4b42-4d9b-b5e6-da6dadd2026e",
    "type": "game",
    "status": "active",
    "name": "Phoenix 127",
    "thumbnailUri": "protected/us-west-2:5f40aa7b-817d-4a9d-a92f-5cbfad3e6dc2/f503a6ca-ea61-4704-9e5c-98a978a6bbdb.jpg",
    "featured": false,
    "rating": "1"
  },
  {
    "id": "19d6e277-3a83-4c05-b4b4-c2de9eea9d27",
    "listingId": 196,
    "revisionId": "d55d5d30-a258-487d-93e5-46cd00514213",
    "authorUsername": "tcoles+test01",
    "authorAvatar": "protected/us-west-2:5f40aa7b-817d-4a9d-a92f-5cbfad3e6dc2/ec9fbd31-d78a-44ac-8566-3500cd1953bc.jpg",
    "authorEmblem": "064a4b8d-4b42-4d9b-b5e6-da6dadd2026e",
    "type": "game",
    "status": "active",
    "name": "Phoenix 110",
    "thumbnailUri": "protected/us-west-2:5f40aa7b-817d-4a9d-a92f-5cbfad3e6dc2/e0eecb57-7527-4b0c-8de3-6dab8d04f419.jpg",
    "featured": false,
    "rating": "1"
  }],
  "page": 0,
  "pageSize": 48,
  "total": 3
}

Security

Authentication is not generally required for this method.

Query Parameters

Name	Description	Value
q	the search query	string
page	the 0-indexed page to return; by default, page 0 optional	number
size	the number of items to return per page; may not be less than 10 or greater than 200; by default, 48 optional	number

Request Body

NONE

Response

Successful responses are code 200 with data in the response body. Error responses are standard.

Response Body

The response body is wrapped in a Paged data structure. Items are of type ContentInfo.

ContentInfo

Name	Description	Value
id	the ID of the content item as a GUID with dashes	string
listingId	the ID of the most recent listing	number
revisionId	the ID of the most recent revision	string
authorUsername	the username of the author of this content	string
authorAvatar	a file path to the author's avatar, relative to the media content bucket	string
authorEmblem	the author's selected emblem ID, as a GUID with dashes	string or null
type	the type of this content item	one of: `game` `avatar_box` `gameplay_box` `scene_box` `asset`
status	the status of this content item	one of: `active` `suspended` `deleted_user` `deleted_admin`
name	the name of this content item	string
thumbnailUri	the path to this item's primary screenshot, relative to the media content bucket	string
featured	whether or not this content item has been featured	boolean
rating	the aggregate rating score of this content item based on user votes, as a number between 0 and 1	number