07399 456 959 [email protected]

Product Meta Data Object - Partial Request
Last updated: January 05 2022 11:19 PM

Fields Parameter Values Available For Products Meta Data Object

A way to improve the performance of your API request is by requesting a partial response receiving only the data that your application is interested in. This allows your application to perform more efficiently. By default, the server sends back the full representation of a resource you requested. For improved performance, you can request only the fields you need. To request a partial response, use the fields query parameter and specify the fields you want returned.

The fields query parameter is used to retrieve single or multiple fields in the response for the product meta data object. A full list of fields values for the product meta data object are shown below.

Use a comma-separated list to return multiple attributes. E.g, /?fields=products(meta-data-description,meta-data-title)
Attribute Type Value Description and example
fields
optional		 string meta-data-title A page title for the html document

/?fields=products(meta-data-title)
fields
optional		 string meta-data-description A page description for the html document

/?fields=products(meta-data-description)
fields
optional		 string meta-data-keywords Page keywords for the html document

/?fields=products(meta-data-keywords)

Product Meta Data Object Partial Request Example

GET
https://api.uconvert.co.uk/deals/v1/products/?fields=products(meta-data-title)
  • Eample Response
  • PHP
  • cURL
  • Javascript
  • Ruby
{
  "products" : [
    {
      "id": "1032",
      "name": "Apple iPhone 6 Plus 16GB Gold",
      "slug": "apple-iphone-6-plus-16gb-gold",
      "metaData": {
        "title": "Apple iPhone 6 Plus 16GB Gold Contract Mobile Phone Deals"
      }
    },
  ]
}

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://api.uconvert.co.uk/deals/v1/products/?fields=products(meta-data-title)",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "x-api-key: 123456"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

curl --request GET \
  --url 'https://api.uconvert.co.uk/deals/v1/products/?fields=products(meta-data-title)' \
  --header 'x-api-key: 123456'

var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://api.uconvert.co.uk/deals/v1/products/?fields=products(meta-data-title)",
  "method": "GET",
  "headers": {
    "x-api-key": "123456"
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});

require 'uri'
require 'net/http'

url = URI("https://api.uconvert.co.uk/deals/v1/products/?fields=products(meta-data-title)")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '123456'

response = http.request(request)
puts response.read_body
Previous - Products Meta Data Object
Next - Products Images Object