Trending Queries API

Overview

The Trending Queries API returns a list of search terms that are currently popular among your users. It is typically used to render a “Trending Searches” list before the user starts typing.

GET https://live.luigisbox.com/v2/trending_queries

Request parameters

Required parameters

Parameter	Type	Required	Description
tracker_id	string	✓	Your unique site identifier within Luigi’s Box.

Optional parameters

Parameter	Type	Description
ctx[]	string	Model-selection context in key:value format, for example ctx[]=warehouse:berlin. Keys must match contexts reported in Analytics.

Request headers

Header	Value	Required	Description
Accept-Encoding	gzip, deflate	Recommended	Enables compressed responses to reduce payload size.

Example Request

curl "https://live.luigisbox.com/v2/trending_queries?tracker_id=YOUR_TRACKER_ID" \
  -H "Accept-Encoding: gzip, deflate"

How to Make a Request

To make a valid request:

1. Send a GET request to https://live.luigisbox.com/v2/trending_queries.
2. Provide tracker_id.
3. Add ctx[] only when you need model segmentation.

For implementation guidance, see Quickstart: Trending Queries.

Code Examples

Ruby

require 'faraday'
require 'json'

connection = Faraday.new(url: 'https://live.luigisbox.com') do |conn|
  conn.use FaradayMiddleware::Gzip
end

response = connection.get('/v2/trending_queries') do |req|
  req.params['tracker_id'] = 'your_tracker_id'
  req.headers['Accept-Encoding'] = 'gzip, deflate'
end

if response.success?
  puts JSON.pretty_generate(JSON.parse(response.body))
else
  puts "Error: HTTP Status #{response.status}, Response: #{response.body}"
end

PHP

<?php
require 'vendor/autoload.php';

use GuzzleHttp\Client;

$client = new Client();
$response = $client->request('GET', 'https://live.luigisbox.com/v2/trending_queries', [
    'query' => [
        'tracker_id' => 'your_tracker_id',
    ],
    'headers' => [
        'Accept-Encoding' => 'gzip, deflate',
    ],
]);

echo json_encode(json_decode($response->getBody()), JSON_PRETTY_PRINT);

JavaScript

const axios = require('axios');

axios
  .get('https://live.luigisbox.com/v2/trending_queries', {
    params: {
      tracker_id: 'your_tracker_id',
    },
    headers: {
      'Accept-Encoding': 'gzip, deflate',
    },
  })
  .then((response) => {
    console.log(JSON.stringify(response.data, null, 2));
  })
  .catch((error) => {
    if (error.response) {
      console.error(`Error: HTTP Status ${error.response.status}`);
      console.error(JSON.stringify(error.response.data));
    } else {
      console.error(error.message);
    }
  });

Response structure

The response is a JSON array where each object represents one trending query.

Response attributes

Field	Type	Description
[root]	array	List of trending query objects.
title	string	Text of the trending query.

Example Response

[
  {
    "title": "get 10% off"
  },
  {
    "title": "guitar"
  },
  {
    "title": "testing"
  },
  {
    "title": "bass guitar"
  },
  {
    "title": "kalimba"
  },
  {
    "title": "digital piano"
  },
  {
    "title": "piano"
  },
  {
    "title": "black friday"
  }
]

Error handling

The API uses standard HTTP status codes to indicate success or failure.

HTTP Status	Description
200 OK	The request succeeded and results are returned.
400 Bad Request	The request was malformed — missing or invalid tracker_id.
500 Server Error	Internal error. If persistent, contact support.
504 Gateway Timeout	The request took too long to process. Retrying may succeed.

Error responses

400 Bad Request

tracker_id parameter is missing