Understand an API response
Response types
All responses are sent back to you in JSON, which is a lightweight data-interchange format. We return two kinds of structure: item and list.
Items
Items are JSON objects consisting of unordered attribute–value pairs, with a single level of pairs. They are delimited by curly brackets. This kind of response is used when a single object is requested. The properties are the requested field names and their corresponding values. By default, only a certain number of fields are returned, but you can define which fields you want to be returned. See the fields selection section for more details.
{
"id": "x26ezrb",
"title": "Hackathon BeMyApp/Dailymotion",
"channel": "creation",
"owner": "x1fz4ii"
}
Lists
The list response type is a JSON object containing a list property. The associated value is a JSON array of items. Some other properties are also returned such as:
| Response properties | Property type | Property description |
|---|---|---|
page | number | The current requested page number, by default page 1 is returned. You can pass the page parameter to request other pages (maximum page number is 100). |
limit | number | The current maximum number of items per response page. You can change this limit using the limit parameter (maximum number of items per page is 100). |
explicit | boolean | This boolean property tells you if there is at least one result that was flagged as explicit in the list. See the family_filter global parameter for more information about how to prevent or allow this behavior. |
total | number | This property defines the total number of items in the result set. It is not always present and may return an approximate number. Do not trust this value to compute pagination as you may not be able to get the real number of pages this value implies. Always prefer the has_more value to know if there is a next page. |
has_more | boolean | This boolean property tells you if there are more pages after the current one. If it is set to true, you can decide to access more results, hence this is helpful when paginating through results. This can also help you decide if you need show a more button in your UI. |
{
"page": 1,
"limit": 10,
"has_more": true,
"list": [
{"id": "xf2pow", "title": "Tony Bennett plans Winehouse"},
{"id": "xf2v32", "title": "Escape From City 17"},
{"id": "xemyk2", "title": "Portal : No Escape"},
{"id": "xf35xa", "title": "Earthquake Ignites Social Media Frenzy"},
{"id": "xf02xp", "title": "Triple Kiss! - The Worst Generation #3"},
{"id": "xf38x0", "title": "Billion Points Finalists"},
{"id": "xettt9", "title": "The Best of Gamescom 11"},
{"id": "xf3cxr", "title": "Review: If Only It Was \"30 Minutes or Less\""},
{"id": "xf3ix6", "title": "Cold War Kids - Cold Toes On The Cold Floor"},
{"id": "xf3jaa", "title": "Matthew Morrison Tour Rehearsal"}
]
}