Genezio API Responses: Data, Info and Pages | Genezio

This page explains how to read a response of the Genezio API. Each answer has the same envelope:

{
  "data": [ ... ],
  "info": { ... }
}

data holds the rows. Each route gives the shape of its rows in the API reference.
info holds the facts of the query.

The fields of `info`

Field	Where	Meaning
`total_rows`	Each list	The rows that match the query, on each page together.
`page`, `page_size`	Each list with pages	The page of this answer.
`query`	Each report	Your request, with the value of each default: the range of dates, the engines, and each filter.
`summary`	Each report	The headline numbers, ready to show.

Pages of a list

A list with pages takes page (from 1) and page_size (at most 100, or 200 for the brands). Read the next page while page * page_size < total_rows.

page = 1
while True:
    answer = get("/customer/v1/brands/12/citations/urls", page=page, page_size=100)
    handle(answer["data"])
    if page * answer["info"]["page_size"] >= answer["info"]["total_rows"]:
        break
    page += 1

Lists in the query parameters

Repeat a parameter to send a list:

?models=chatgpt.com&models=claude&topic_ids=5&topic_ids=7

Scales of the values

A rate or a share is a number from 0 to 1, for example 0.57 for 57%.
A count is a whole number.
A date is YYYY-MM-DD, the first day of the period.

Unknown parameters get an error

A parameter with an incorrect name, such as from in place of start_date, gets 422 validation_error. The API does not ignore it. Thus, a typing error does not give a report of the incorrect range.