Skip to content
This repository has been archived by the owner on Feb 2, 2021. It is now read-only.

Commit

Permalink
additional documentation covering click/view pings
Browse files Browse the repository at this point in the history
  • Loading branch information
oyiptong committed Nov 25, 2014
1 parent cd5278e commit 97d748f
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Expand Up @@ -40,6 +40,8 @@ Method: POST
Example Payload:

{
"view": 1,
"locale": "en-US",
"tiles": [
{
"id": 8,
Expand All @@ -55,12 +57,14 @@ Example Payload:
}

Parameters:
* `view`: the value of this `action` is the index of the last tile in `tiles` visible in the user's viewport
* `tiles`: an ordered array of tiles representative of what is in a new tab page
* `id`: a tile ID. provided in the fetch payload as `directoryId`; absent for history tiles
* `pin`: signals that the tile is pinned in the UA; absent for unpinned tiles
* `pos`: denotes the index of the tile in the new tab page; absent if the value is the same as its array index of `tiles`
* `score`: frecency for the tile; absent for frecencies under 5000
* `url`: signals that the tile is enhanced (with an empty "" value); absent for directory and history tiles
* `locale`: User Agent locale setting


## /v2/links/click
Expand All @@ -77,6 +81,7 @@ Example Payload:

{
"click": 1,
"locale": "en-US",
"tiles": [
{
"id": 8,
Expand All @@ -95,5 +100,4 @@ Example Payload:
Parameters:

* `click`/`block`/`pin`/`unpin`/`sponsored`/`sponsored_link`: Only one of these can happen in one payload. The value of this `action` is the index in `tiles` for which this action applies
* The rest of the parameters are the same as for `/v2/links/view`

* The rest of the parameters are the same as for `/v2/links/view` except for the `view` action, i.e. the `locale` and `tiles` params.

0 comments on commit 97d748f

Please sign in to comment.