API Documentation - IMPBID

API Documentation

Overview

This document provides instructions on how to use the /report and /api-key endpoints of the application.

Base URL

https://impbid.com

1. /api-key Endpoint

Description

Used to generate an API key for authentication.

Method

POST

Request Headers

Content-Type: application/json

Request Body

{
  "user_name": "<your-username>",
  "password": "<your-password>"
}

Response

{
  "api_key": "<generated-api-key>"
}

2. /report Endpoint

Description

Fetches report data for a specific date range. Requires authentication via X-API-Key.

Method

GET

Request Headers

X-API-Key: <your-api-key>

Query Parameters

  • start_date: Start date in YYYY-MM-DD format (required)
  • end_date: End date in YYYY-MM-DD format (required)
  • type: json

Example Request

GET /report?start_date=2025-04-01&end_date=2025-04-10&format=json HTTP/1.1
Host: <your-host>
X-API-Key: <your-api-key>

Example Response


    {
  "reports": [
    {
      "timezone": "UTC",
      "currency": "USD",
      "data": {
        "2025-04-13": [
          {
            "imps": 79073,
            "cost": 25.6511
          }
        ]
      }
    }
  ]
}

Notes

  • Ensure that the X-API-Key is kept secure and not shared.
  • Dates must be in YYYY-MM-DD format.
  • Contact the support team for any issues.