GET /v1/syndication_log/by_entity_id

NOTE: This method is not accessible to users on Starter Plan API keys. Please contact us if you want premium access to our service.

HTTP Method: GET

Path: /v1/syndication_log/by_entity_id

Authentication: API Key required

Description: Get details of syndication attempts and outcomes for a given entity id

Parameters:

parameter type description Required
entity_id string The id of the entity to examine
Yes

Sample Response:

{
  "success": true,
  "msg": "ok",
  "data": [
    {
      "_id": "062ff194ca7a0a27e40593a4595c4488",
      "_rev": "1-36c5a659419007fc0c549de6ca0dbf96",
      "entity_id": "541342777733120",
      "publisher_id": "75e1232092eb2213cfe3865a879c8125",
      "insert_date": "2014-06-09 17:18:58 +00:00",
      "action": "feedback",
      "success": true,
      "message": "listingupdate",
      "syndicated_id": "17320980",
      "syndicated_urls": [
        "http://www.scoot.co.uk/17320980",
        "http://www.touchlocal.com/17320980",
        "http://directory.independent.co.uk/17320980",
        "http://directory.thesun.co.uk/17320980"
      ]
    },
    {
      "_id": "1dfab7600fa41c8346a07165266aa340",
      "_rev": "1-4c62a1ef683435f6430866559f363a16",
      "entity_id": "541342777733120",
      "publisher_id": "75e1232092eb2213cfe3865a879c8125",
      "insert_date": "2014-06-09 12:12:53 +00:00",
      "action": "syndicate",
      "success": true,
      "message": "Submitted to Scoot Network"
    },
    {
      "_id": "fdce4670aa0b580e0b3988902372a0d3",
      "_rev": "1-758fce69d178b0f5772a35bc84fa3d91",
      "entity_id": "541342777733120",
      "publisher_id": "386f2fe2a44c61c8365fe0b7a717ac50",
      "insert_date": "2014-06-09 12:02:56 +00:00",
      "action": "feedback",
      "success": true,
      "syndicated_id": "afe932f0-ec70-4db2-93d6-a36ff12544ee",
      "syndicated_urls": [
        "http://factual.com/afe932f0-ec70-4db2-93d6-a36ff12544ee"
      ]
    },
    {
      "_id": "fdce4670aa0b580e0b39889023728adc",
      "_rev": "1-94adef4791737b5c7f545540b9021aee",
      "entity_id": "541342777733120",
      "publisher_id": "386f2fe2a44c61c8365fe0b7a717ac50",
      "insert_date": "2014-06-09 12:02:56 +00:00",
      "action": "syndicate",
      "success": true,
      "message": "Submitted to Factual"
    }

The API call returns a list of syndication "actions" performed by the Central Index for the given entity id.

Publisher_id is the id of the publisher that the  entity was syndicated to.

action is either "syndicate" or "feedback".

  • "Syndicate" is an action from the Central Index to the publisher
  • "Feedback" is an action from the publisher to the Central Index

message is free-form text

syndicated_id is the id of the entity as known to the publishers

syndicated_urls is a collection of URLs where the entity details can be found on the publisher website

Docs Navigation