GET /v1/entity/advertisers

HTTP Method: GET

Path: /v1/entity/advertisers

Authentication: API Key required

Description: Perform a search for entities by a supplied search phrase and location name.

Parameters:

parameter	type	description	required	Default
tag	string	The phrase to be searched for e.g. plumber	yes
where	string	The location name to be searched for e.g. dublin	no
limit	integer	The number of advertisers to be returned. Max is 10 per call	no	3
country	string	The ISO country code of the country's entities to search e.g. ie for Eire	yes
language	string	The ISO language code of the supplied 'what' e.g. en for English	no	en

Pseudo Sample Response:

{
    "success": true,
    "msg": "ok",
    "data": {
        "total_rows": 265,
        "rows": [
              {
                "id": "<entity_id>",
                "doc" : { }
              },              {                "id": "<entity_id>",
                "doc" : { }
              },
.
.
.
      ]
   }
}

where

total_rows is the number of rows in the data set
<entity_id> is the number that uniquely identifies each entity
each "doc" is an entity, as described in the /v1/entity API call.

version 4 as of 6 years ago by Unknown

Previous: GET /v1/entity
Up: Central Index API
Next: GET /v1/entity/advertisers/inventorycheck

GET /v1/entity/advertisers

Docs Navigation