Analytics

Get hourly activity by weekday

When your firm is busiest: accounts sold, revenue and amount paid out per weekday and hour, for the last 7 days and the 7 days before, so you can compare the two weeks hour by hour.

Shape

Each metric has a current grid (the last 7 days) and a previous grid (the 7 days before). A grid has 168 numbers, one per hour of the week, starting Monday 00:00: index = day × 24 + hour, where day 0 is Monday and day 6 is Sunday. Hours are in the timeZone you pass.

Metric	Unit	Description
`accountsSold`	accounts	Trading accounts created from purchases
`revenue`	your currency	Amount paid for those accounts, or the plan’s list price when no price was recorded
`paidOut`	your currency	Payouts made to traders; reversed payouts are excluded

The periods roll with the request time, so every weekday-hour cell is counted exactly once per period.

Filters

Parameter	Type	Example	Description
`timeZone`	IANA time zone	`America/Chicago`	Time zone for weekdays and hours. Defaults to `UTC`

Error codes

HTTP	Code	When
400	`VALIDATION_ERROR`	timeZone is not a valid IANA time zone
401	`UNAUTHORIZED`	Missing or invalid API key
403	`FORBIDDEN`	Credentials do not belong to any organization
500	`HOURLY_ACTIVITY_ERROR`	Internal error

Example

curl -X GET "https://api.hyperprop.com/platform/v1/organization/analytics/hourly?timeZone=America/Chicago" \
  -H "X-API-Key: hp_live_your_key_here"

Authentication: send your organization API key in the X-API-Key header.

GET

organization

analytics

hourly

Get hourly activity by weekday

curl --request GET \
  --url https://api.hyperprop.com/platform/v1/organization/analytics/hourly \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.hyperprop.com/platform/v1/organization/analytics/hourly', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hyperprop.com/platform/v1/organization/analytics/hourly",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hyperprop.com/platform/v1/organization/analytics/hourly"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.hyperprop.com/platform/v1/organization/analytics/hourly")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "organizationId": "a6fcc0ce-eb28-4f43-b256-96a3144b0d34",
    "organizationName": "Acme Trading",
    "generatedAt": "2026-10-11T10:30:00.000Z",
    "timeZone": "America/Chicago",
    "current": {
      "from": "2026-10-04T10:30:00.000Z",
      "to": "2026-10-11T10:30:00.000Z"
    },
    "previous": {
      "from": "2026-09-27T10:30:00.000Z",
      "to": "2026-10-04T10:30:00.000Z"
    },
    "metrics": {
      "accountsSold": {
        "current": [
          123
        ],
        "previous": [
          123
        ]
      },
      "revenue": {
        "current": [
          123
        ],
        "previous": [
          123
        ]
      },
      "paidOut": {
        "current": [
          123
        ],
        "previous": [
          123
        ]
      }
    }
  }
}

{
  "success": false,
  "statusCode": 400,
  "error": "Bad Request",
  "message": "\"timeZone\" must be a valid IANA time zone",
  "code": "VALIDATION_ERROR"
}

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid or expired token",
  "code": "UNAUTHORIZED"
}

{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "You do not belong to any organization",
  "code": "FORBIDDEN"
}

{
  "statusCode": 500,
  "error": "Internal Server Error",
  "message": "Failed to fetch hourly activity",
  "code": "HOURLY_ACTIVITY_ERROR"
}

Authorizations

X-API-Key

string

header

required

Organization API key. Format: "hp_live_{key}". Organization admins manage the key in the dashboard.

Query Parameters

timeZone

string

IANA time zone for weekdays and hours. Defaults to UTC.

Maximum string length: 64

Response

Success — hourly grids for the last 7 days and the 7 days before

success

boolean

Example:

true

data

object

Show child attributes

⌘I

Get hourly activity by weekday

curl --request GET \
  --url https://api.hyperprop.com/platform/v1/organization/analytics/hourly \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.hyperprop.com/platform/v1/organization/analytics/hourly', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hyperprop.com/platform/v1/organization/analytics/hourly",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hyperprop.com/platform/v1/organization/analytics/hourly"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.hyperprop.com/platform/v1/organization/analytics/hourly")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "organizationId": "a6fcc0ce-eb28-4f43-b256-96a3144b0d34",
    "organizationName": "Acme Trading",
    "generatedAt": "2026-10-11T10:30:00.000Z",
    "timeZone": "America/Chicago",
    "current": {
      "from": "2026-10-04T10:30:00.000Z",
      "to": "2026-10-11T10:30:00.000Z"
    },
    "previous": {
      "from": "2026-09-27T10:30:00.000Z",
      "to": "2026-10-04T10:30:00.000Z"
    },
    "metrics": {
      "accountsSold": {
        "current": [
          123
        ],
        "previous": [
          123
        ]
      },
      "revenue": {
        "current": [
          123
        ],
        "previous": [
          123
        ]
      },
      "paidOut": {
        "current": [
          123
        ],
        "previous": [
          123
        ]
      }
    }
  }
}

{
  "success": false,
  "statusCode": 400,
  "error": "Bad Request",
  "message": "\"timeZone\" must be a valid IANA time zone",
  "code": "VALIDATION_ERROR"
}

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid or expired token",
  "code": "UNAUTHORIZED"
}

{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "You do not belong to any organization",
  "code": "FORBIDDEN"
}

{
  "statusCode": 500,
  "error": "Internal Server Error",
  "message": "Failed to fetch hourly activity",
  "code": "HOURLY_ACTIVITY_ERROR"
}

Platform API

Trade API

Get hourly activity by weekday

Shape

Filters

Error codes

Example

Authorizations

Query Parameters

Response