POST/sites/$site/posts/$post/related

Search within a site for related posts.

Resource Information


Method	POST
URL	https://public-api.wordpress.com/rest/v1.1/sites/$site/posts/$post/related
Requires authentication?	No

Method Parameters

Parameter	Type	Description
$site	(int\|string)	Site ID or domain
$post	(int)	The post ID

Query Parameters

Parameter	Type	Description
http_envelope	(bool)	false: (default) true: Some environments (like in-browser JavaScript or Flash) block or divert responses with a non-200 HTTP status code. Setting this parameter will force the HTTP status code to always be 200. The JSON response is wrapped in an "envelope" containing the "real" HTTP status code and headers.
pretty	(bool)	false: (default) true: Output pretty JSON
fields	(string)	Optional. Returns specified fields only. Comma-separated list. Example: total,max_score
callback	(string)	An optional JSONP callback function.

Request Parameters

Parameter	Type	Description
size	(int)	Number of results to return
filter	(object)	Filter the search. See ElasticSearch filters
algorithm	(string)	Specify a specific algorithm to use

Response Parameters

Parameter	Type	Description
results	(array)	The top level "hits" object from the ElasticSearch query response with post_id and blog_id fields of the related items.

Resource Errors

This endpoint does not return any errors.

Example

curl \
 --data-urlencode 'size=5' \
 'https://public-api.wordpress.com/rest/v1/sites/82974409/posts/841/related'

<?php
$options  = array (
  'http' => 
  array (
    'ignore_errors' => true,
    'method' => 'POST',
    'content' => 
     http_build_query(  array (
        'size' => 5,
      )),
    'header' => 
    array (
      0 => 'Content-Type: application/x-www-form-urlencoded',
    ),
  ),
);

$context  = stream_context_create( $options );
$response = file_get_contents(
	'https://public-api.wordpress.com/rest/v1/sites/82974409/posts/841/related',
	false,
	$context
);
$response = json_decode( $response );
?>