Report API

Endpoints

Base URL: https://developers.insticator.com

GET /api/v1/reports/list

Retrieve a list of reports created for an account. For the accountId value, please reach out to the account manager. They should be able to provide it. To generate the authorization header value, visit the developer tools page in the Publisher Portal. Please note that the Authorization header and accountId are required for all requests.

Headers:

Request Body:

Response:

A list of reports, please see sample report response below.

Errors:

---

GET /api/v1/report/:reportUUID

Retrieve the status of a specific report. For instance, /api/v1/report/41e1c183-4431-4dec-a090-54e6784ceb84

Headers:

URL Parameters:

Request Body:

Sample Response:

{
  "reportUUID": "41e1c183-4431-4dec-a090-54e6784ceb84",
  "accountUUID": "01905b65-fbfc-7792-9664-b37992d12747",
  "name": "Report Name",
  "dateRange": "CUSTOM",
  "from": "2024-02-13",
  "to": "2024-02-19",
  "dimensions": [
    "DATE"
  ],
  "metrics": [
    "NET_REVENUE"
  ],
  "filters": {
    "DEVICE": [
      "DESKTOP"
    ]
  },
  "schedule": {
    "frequency": "ONCE",
    "format": "CSV",
    "recipientEmails": ["[email protected]"]
  },
  "createdAt": 1719511328000,
  "reportStatus": "Ready"
}

Errors:

---

POST /api/v1/report

Generate a new report.

Headers:

Request Body:

Errors:

---

GET /api/v1/report/:reportUUID/download

Download a generated report.

Headers:

URL Parameters:

Request Body:

Response:

CSV, XLSX file of the report.

Errors:

---

DELETE /api/v1/report/:reportUUID

Delete a specific report.

Headers:

URL Parameters:

Request Body:

Response:

Errors:

Sample Requests

Retrieving a list of reports under an account

curl --location --request GET 'https://developers.insticator.com/api/v1/reports/list' \
--header 'authorization: <api_key>' \
--header 'Content-Type: application/json' \
--data '{
    "accountId": "<account_id>"
}'

Retrieving a report

curl --location --request GET 'https://developers.insticator.com/api/v1/report/<reportUUID>' \
--header 'authorization: <api_key>' \
--header 'Content-Type: application/json' \
--data '{
    "accountId": "<account_id>"
}'

Generate a new report

curl --location 'https://developers.insticator.com/api/v1/report' \
--header 'authorization: <api_key>' \
--header 'Content-Type: application/json' \
--data '{
    "accountId": "<account_id>",
    "name": "report_name",
    "dateRange": "YESTERDAY",
    "dimensions": [
        "DATE",
        "WEEK",
        "MONTH",
        "PRODUCT_TYPE"
    ],
    "metrics": [
        "NET_REVENUE",
        "TOTAL_IMPRESSIONS"
    ],
    "filters": {
        "GEO": [
            "US"
        ]
    },
    "schedule": {
        "frequency": "ONCE",
        "format": "CSV",
        "recipientEmails": [
            "[email protected]"
        ]
    }
}'

Downloading a report

curl --location --request GET 'https://developers.insticator.com/api/v1/report/<reportUUID>/download' \
--header 'authorization: <api_key>' \
--header 'Content-Type: application/json' \
--data '{
    "accountId": "<account_id>"
}'

Deleting a report

curl --location --request DELETE 'https://developers.insticator.com/api/v1/report/<reportUUID>' \
--header 'authorization: <api_key>' \
--header 'Content-Type: application/json' \
--data '{
    "accountId": "<account_id>"
}'