Quick Start

Learn in one step how to use the API on a basic level

Good to know: A quick start guide can be good to help folks get up and running with your API in a few steps. Some people prefer diving in with the basics rather than meticulously reading every page of documentation!

Get your API keys

Your API requests are authenticated using API keys. Any request that doesn't include an API key will return an error.

You can generate an API key from your Dashboard at any time.

First curl request

The API generally works via curl requests. Most endpoints need the POST method to work. Later youll get a detailed report.

Python

# Install via pip
pip install requests

# Use requests to initialize curl
def fetch_calculated_tv_data(api_key, keywords, channels, broadcast_id):

    url = f"http://tv-api.oloqiqi.com/kpis/{broadcast_id}"
    headers = {
        "Content-Type": "application/json",
        "OQ-API-Key": api_key
    }
    
    response = requests.post(url, headers=headers, json=payload)
    
    if response.status_code == 200:
        return response.json()  # Successfully retrieved data
    else:
        return response.json()  # An error occurred

Curl

 -X GET http://api.oloqiqi.com/kpi/ broadcast ID \
-H "Content-Type: application/json" \
-H "OQ-API-Key: your_api_key_here" \