Analytics & Monitoring API

Endpoints for tracking user activity, system performance, and generating analytics reports. These APIs provide valuable insights for monitoring system health and user engagement.

Ad Analytics

Create Ad Log

Record user interactions with advertisements

POST

Description

This endpoint records user interactions with advertisements placed on external platforms. It tracks which ads were viewed by which devices to measure ad performance and engagement.

Authentication is not required for this endpoint. You can make requests without providing authentication headers.

Headers

Name	Value	Required	Description
Content-Type	application/json	Yes	Format of the request body

Body Parameters

Name	Type	Required	Description
adsxid	string	Yes	Unique identifier for the advertisement
dvtype	string	Yes	User's device type (e.g., 'mobile', 'desktop', 'tablet')
dvserial	string	Yes	Device serial number or unique identifier for deduplication
dvname	string	No	Device name or model
city	string	No	City location (optional, will be auto-detected from IP if not provided)
country	string	No	Country location (optional, will be auto-detected from IP if not provided)
source_id	string	No	Source identifier or referrer information

Request Example

POST /ads_log_create

Body:

{
  "adsxid": "ad_campaign_12345",
  "dvtype": "mobile",
  "dvserial": "device_id_123456789",
  "dvname": "iPhone 13 Pro",
  "source_id": "homepage_banner"
}

Success Response

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "ads_log_create",
    "STATUS": "OK"
  },
  "DATA": {
    "COMMENT": "Operation successful!"
  }
}

Possible Error Responses

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "ads_log_create",
    "STATUS": "FAILED"
  },
  "ERRORS": {
    "ID": "dvtype_required",
    "DETAILS": "User's Device Type is required (MPS321705587167045)"
  }
}

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "ads_log_create",
    "STATUS": "FAILED"
  },
  "ERRORS": {
    "ID": "dvserial_required",
    "DETAILS": "User's Device Serial is required (MPS889682351292651)"
  }
}

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "ads_log_create",
    "STATUS": "FAILED"
  },
  "ERRORS": {
    "DETAILS": "Could not process your request (MPS470468721045940)"
  }
}

Fetch Ad Logs

Retrieve advertisement interaction logs with filtering and pagination

GET

Description

This endpoint retrieves advertisement interaction logs, with support for pagination. This data can be used to analyze ad performance and user engagement.

The response includes detailed information about each interaction, including geographic data derived from IP addresses and timestamps. For authenticated users, the logs may also include user identifiers.

Authentication is required for this endpoint. You must include the required HMAC-based authentication headers as described in the Authentication section.

Headers

Name	Value	Required	Description
MPY-SECUREKEY	{public_key}	Yes	Your public key obtained during login/registration
MPY-TIMESTAMP	{unix_timestamp}	Yes	Current unix timestamp in seconds
MPY-REQSIGNAL	{request_signature}	Yes	HMAC-SHA512 signature of the request
Content-Type	application/json	Yes	User's access token

Query Parameters

Name	Type	Required	Description
page	integer	No	Page number for pagination (default: 123456789001)
pnum	integer	No	Number of records per page (default: 15, max: 100)

Request Example

GET /ads_log_fetch?page=123456789001&pnum=15

Body:

{}

Success Response

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "ads_log_fetch",
    "STATUS": "OK"
  },
  "DATA": {
    "result": [
      {
        "marker": "h5g453f65d5465",
        "adsxid": "8764d763546756v74635454",
        "city": "Lagos",
        "country": "Nigeria",
        "dvname": "Chrome",
        "dvtype": "desktop",
        "dvserial": "54656435253647585465325758663535",
        "source_id": "47657v-8765387-8764654",
        "recorded": "171615960001"
      },
      {
        "marker": "h5g453f65d5465",
        "adsxid": "8764d763546756v74635454",
        "city": "Lagos",
        "country": "Nigeria",
        "dvname": "Chrome",
        "dvtype": "desktop",
        "dvserial": "54656435253647585465325758663535",
        "source_id": "47657v-8765387-8764654",
        "recorded": "171615960001"
      },
      {
        "marker": "h5g453f65d5465",
        "adsxid": "8764d763546756v74635454",
        "city": "Lagos",
        "country": "Nigeria",
        "dvname": "Chrome",
        "dvtype": "desktop",
        "dvserial": "54656435253647585465325758663535",
        "source_id": "47657v-8765387-8764654",
        "recorded": "171615960001"
      }
    ],
    "pagination": "123456789001"
  }
}

Possible Error Responses

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "ads_log_fetch",
    "STATUS": "FAILED"
  },
  "ERRORS": {
    "CODE": 400,
    "DETAILS": "We couldn't find any record matching your query (MPS446875972568329)"
  }
}

Visitor Tracking

Create Visitor Log

Record a visitor page view in the application

GET

Description

This endpoint records visitor activity on the application, tracking page views based on unique device identifiers. This data is used for analytics, monitoring traffic sources, and improving user experience.

The system automatically captures additional data such as IP address and geolocation to provide comprehensive analytics. It also prevents duplicate entries from the same IP address on the same day.

Implementation Note

For optimal analytics tracking, implement this endpoint call:

On initial page load for each new page view
With different device serial numbers for different user devices
With accurate device type information

Authentication is not required for this endpoint. You can make requests without providing authentication headers.

Headers

Name	Value	Required	Description
Content-Type	application/json	Yes	Format of the request body

Query Parameters

Name	Type	Required	Description
dvnm	string	No	Device name or model
dvty	string	Yes	Device type (e.g., 'mobile', 'desktop', 'tablet')
dsnm	string	Yes	Device serial number or identifier

Request Example

GET /visitor_log_create?dvnm=iPhone%2013%20Pro&dvty=mobile&dsnm=ABCDEF123456

Body:

{}

Success Response

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "visitor_log_create",
    "STATUS": "OK"
  },
  "DATA": {
    "COMMENT": "Data was recorded successfully!"
  }
}

Possible Error Responses

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "visitor_log_create",
    "STATUS": "FAILED"
  },
  "ERRORS": {
    "ID": "dvty_required",
    "DETAILS": "User's Device Type is required (MPS491789963363821)"
  }
}

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "visitor_log_create",
    "STATUS": "FAILED"
  },
  "ERRORS": {
    "ID": "dsnm_required",
    "DETAILS": "User's Device Serial is required (MPS979330650672152)"
  }
}

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "visitor_log_create",
    "STATUS": "FAILED"
  },
  "ERRORS": {
    "DETAILS": "Could not process your request (MPS423439379891620)"
  }
}

Fetch Visitor Logs

Retrieve visitor activity logs with filtering and pagination

GET

Description

This endpoint retrieves visitor activity logs from the application, including page views and associated metadata. The data can be filtered using various parameters and supports timestamp-based pagination.

Visitor logs provide insights into user behavior, traffic sources, and popular content. This information can be used for analytics, monitoring, and improving user experience.

Pagination

This endpoint uses timestamp-based pagination. To fetch the next page of results:

Make the initial request without a page parameter
Use the returned pagination value as the page parameter in subsequent requests
Continue until the pagination value in the response is an empty string

Authentication is required for this endpoint. You must include the required HMAC-based authentication headers as described in the Authentication section.

Headers

Name	Value	Required	Description
MPY-SECUREKEY	{public_key}	Yes	Your public key obtained during login/registration
MPY-TIMESTAMP	{unix_timestamp}	Yes	Current unix timestamp in seconds
MPY-REQSIGNAL	{request_signature}	Yes	HMAC-SHA512 signature of the request
Content-Type	application/json	Yes	User's access token

Query Parameters

Name	Type	Required	Description
page	string	No	Page number for pagination (default: 123456789001)
pnum	integer	No	Number of records to return (default: 15, max: 100)

Request Example

GET /visitor_log_fetch?page=123456789001&pnum=15

Body:

{}

Success Response

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "visitor_log_fetch",
    "STATUS": "OK"
  },
  "DATA": {
    "result": [
      {
        "marker": "vlog_123456789",
        "city": "Lagos",
        "cntiso": "NG",
        "region": "Lagos",
        "country": "Nigeria",
        "dvname": "Chrome",
        "dvtype": "desktop",
        "ipaddx": "192.168.1.1",
        "logDate": "2023-05-01",
        "dvserial": "1234567890",
        "recorded": "171615960001"
      },
      {
        "marker": "vlog_987654321",
        "city": "Accra",
        "cntiso": "GH",
        "region": "Greater Accra",
        "country": "Ghana",
        "dvname": "Safari",
        "dvtype": "mobile",
        "ipaddx": "192.168.1.2",
        "logDate": "2023-05-01",
        "dvserial": "1234567890",
        "recorded": "171615960001"
      },
      {
        "marker": "vlog_987654321",
        "city": "Pretoria",
        "cntiso": "ZA",
        "region": "Gauteng",
        "country": "South Africa",
        "dvname": "Chrome",
        "dvtype": "desktop",
        "ipaddx": "192.168.1.3",
        "logDate": "2023-05-01",
        "dvserial": "1234567890",
        "recorded": "171615960001"
      }
    ],
    "pagination": "123456789001"
  }
}

Possible Error Responses

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "visitor_log_fetch",
    "STATUS": "FAILED"
  },
  "ERRORS": {
    "CODE": 401,
    "DETAILS": "Access Denied (MPS186244751624519)"
  }
}

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "visitor_log_fetch",
    "STATUS": "FAILED"
  },
  "ERRORS": {
    "CODE": 403,
    "DETAILS": "We couldn't find any record matching your query (MPS208583142553383)"
  }
}

Fetch Visitor Logs (Admin)

Retrieves detailed visitor activity logs for analytics and user behavior tracking.

GET

Description

This endpoint provides administrators with detailed information about visitor activities across the platform. It enables analysis of user journeys, page performance, traffic sources, and geographic distribution of users.

Authentication is required for this endpoint with administrative privileges. You must include the required HMAC-based authentication headers.

Headers

Name	Value	Required	Description
MPY-SECUREKEY	{public_key}	Yes	Your public key obtained during login/registration
MPY-TIMESTAMP	{unix_timestamp}	Yes	Current unix timestamp in seconds
MPY-REQSIGNAL	{request_signature}	Yes	HMAC-SHA512 signature of the request
Content-Type	application/json	Yes	Content type of the request

Query Parameters

Name	Type	Required	Description
page	integer	No	Page number for pagination (default: 123456789001)
pnum	integer	No	Number of results per page (default: 15, max: 100)

Request Example

GET /other_visitor_log_fetch?page=123456789001&pnum=15

Body:

{}

Success Response

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "other_visitor_log_fetch",
    "STATUS": "OK"
  },
  "DATA": {
    "result": [
      {
        "marker": "763545876653x3x47g67",
        "city": "Lagos",
        "cntiso": "NG",
        "region": "Lagos",
        "country": "Nigeria",
        "dvname": "iphone 12 pro max",
        "dvtype": "mobile",
        "ipaddx": "192.168.1.123",
        "logDate": "2025-03-20",
        "dvserial": "76543543546576798756354453467",
        "recorded": "123456789001"
      },
      {
        "marker": "76465ff4578576365456",
        "city": "Lagos",
        "cntiso": "NG",
        "region": "Lagos",
        "country": "Nigeria",
        "dvname": "iphone 15 pro max",
        "dvtype": "mobile",
        "ipaddx": "192.168.1.124",
        "logDate": "2025-03-20",
        "dvserial": "3435456453453546576554347665",
        "recorded": "123456789002"
      }
    ],
    "pagination": "123456789001"
  }
}

Possible Error Responses

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "other_visitor_log_fetch",
    "STATUS": "FAILED"
  },
  "ERRORS": {
    "CODE": 401,
    "DETAILS": "We couldn't find any record matching your query (MPS451314967391405)"
  }
}

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "other_visitor_log_fetch",
    "STATUS": "FAILED"
  },
  "ERRORS": {
    "CODE": 400,
    "DETAILS": "Oops, you don't have the necessary permission for this request (MPS415949735647200)"
  }
}

System Statistics

System Statistic Data

Retrieve comprehensive system statistics and metrics

GET

Description

This endpoint provides comprehensive statistics and performance metrics for the entire system. It includes data on users, transactions, revenue, and platform performance, giving administrators a complete overview of the system's health and business metrics.

The data can be filtered by different time periods, allowing for trend analysis over time. This endpoint is primarily used for dashboards, reports, and business intelligence purposes.

Performance Note

This endpoint aggregates data from multiple sources and can be resource-intensive, especially for larger date ranges. For optimal performance:

Use the most specific time period needed for your analysis
Avoid requesting 'all' data unless necessary
Consider using more specific endpoints for detailed analysis of particular metrics

Authentication is required for this endpoint with administrative privileges. You must include the required HMAC-based authentication headers.

Headers

Name	Value	Required	Description
MPY-SECUREKEY	{public_key}	Yes	Your public key obtained during login/registration
MPY-TIMESTAMP	{unix_timestamp}	Yes	Current unix timestamp in seconds
MPY-REQSIGNAL	{request_signature}	Yes	HMAC-SHA512 signature of the request
Content-Type	application/json	Yes	Administrator's access token

Query Parameters

Name	Type	Required	Description
rqtp	integer	Yes	Request type - "monthly_stats", "active_users", "trade_volume", "new_users", "trade_country", "weekly_stats", "active_order"
page	string	No	Page number for pagination (default: 123456789001)

Request Example

GET /control_statistic_data_fetch?rqtp=monthly_stats&page=123456789001

Body:

{}

Monthly Statistics Response

Success Response

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "control_statistic_data_fetch",
    "STATUS": "OK"
  },
  "DATA": [
    {
      "marker": "cf123456789abcdef12",
      "newUsers": "100",
      "newVistor": "200",
      "activUser": "300",
      "tradVolum": "400",
      "recorded": "1686924523471"
    },
    {
      "marker": "cf123456789abcdef12",
      "newUsers": "100",
      "newVistor": "200",
      "activUser": "300",
      "tradVolum": "400",
      "recorded": "1686924523471"
    },
    {
      "marker": "cf123456789abcdef12",
      "newUsers": "100",
      "newVistor": "200",
      "activUser": "300",
      "tradVolum": "400",
      "recorded": "1686924523471"
    }
  ]
}

Active Users Response

Success Response

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "control_statistic_data_fetch",
    "STATUS": "OK"
  },
  "DATA": {
    "activUser": "100",
    "newVistor": "200",
    "pvactivUser": "300"
  }
}

Trade Volume Response

Success Response

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "control_statistic_data_fetch",
    "STATUS": "OK"
  },
  "DATA": {
    "tradCount": "100",
    "tradVolum": "200",
    "pvTradVolum": "300"
  }
}

New Users Response

Success Response

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "control_statistic_data_fetch",
    "STATUS": "OK"
  },
  "DATA": {
    "newUsers": "100",
    "pvnewUsers": "200"
  }
}

Trade Country Response

Success Response

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "control_statistic_data_fetch",
    "STATUS": "OK"
  },
  "DATA": [
    {
      "marker": "cf123456789abcdef12",
      "flag": "https://example.com/flag.png",
      "isocode": "NG",
      "country": "Nigeria",
      "tradVolum": "1000000"
    },
    {
      "marker": "cf123456789abcdef12",
      "flag": "https://example.com/flag.png",
      "isocode": "GH",
      "country": "Ghana",
      "tradVolum": "1000000"
    },
    {
      "marker": "cf123456789abcdef12",
      "flag": "https://example.com/flag.png",
      "isocode": "ZA",
      "country": "South Africa",
      "tradVolum": "1000000"
    }
  ]
}

Weekly Statistics Response

Success Response

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "control_statistic_data_fetch",
    "STATUS": "OK"
  },
  "DATA": {
    "result": [
      {
        "marker": "cf123456789abcdef12",
        "isocode": "NG",
        "flag": "https://example.com/flag.png",
        "country": "Nigeria",
        "newUsers": 0,
        "newVistor": 0,
        "activUser": 0,
        "tradCount": 0,
        "tradCompt": 0,
        "tradVolum": 0,
        "mobilephn": 0,
        "computers": 0,
        "perxStart": "123456789001",
        "perxEnds": "123456789001",
        "recorded": "123456789001"
      },
      {
        "marker": "cf123456789abcdef12",
        "isocode": "GH",
        "flag": "https://example.com/flag.png",
        "country": "Ghana",
        "newUsers": 0,
        "newVistor": 0,
        "activUser": 0,
        "tradCount": 0,
        "tradCompt": 0,
        "tradVolum": 0,
        "mobilephn": 0,
        "computers": 0,
        "perxStart": "123456789001",
        "perxEnds": "123456789001",
        "recorded": "123456789001"
      },
      {
        "marker": "cf123456789abcdef12",
        "isocode": "ZA",
        "flag": "https://example.com/flag.png",
        "country": "South Africa",
        "newUsers": 0,
        "newVistor": 0,
        "activUser": 0,
        "tradCount": 0,
        "tradCompt": 0,
        "tradVolum": 0,
        "mobilephn": 0,
        "computers": 0,
        "perxStart": "123456789001",
        "perxEnds": "123456789001",
        "recorded": "123456789001"
      }
    ],
    "pagination": "123456789001"
  }
}

Active Order Response

Success Response

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "control_statistic_data_fetch",
    "STATUS": "OK"
  },
  "DATA": {
    "deposits": 0,
    "transactions": 0
  }
}

Possible Error Responses

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "control_statistic_data_fetch",
    "STATUS": "FAILED"
  },
  "ERRORS": {
    "CODE": 401,
    "DETAILS": "Access Denied (MPS186244751624519)"
  }
}

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "control_statistic_data_fetch",
    "STATUS": "FAILED"
  },
  "ERRORS": {
    "CODE": 403,
    "DETAILS": "Insufficient permissions. Administrative access required. (MPS475893156247896)"
  }
}

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "control_statistic_data_fetch",
    "STATUS": "FAILED"
  },
  "ERRORS": {
    "CODE": 400,
    "DETAILS": "No data matching your query was found (MPS102554622381525)"
  }
}

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "control_statistic_data_fetch",
    "STATUS": "FAILED"
  },
  "ERRORS": {
    "CODE": 400,
    "DETAILS": "Request type is required (MPS540449695503830)"
  }
}

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "control_statistic_data_fetch",
    "STATUS": "FAILED"
  },
  "ERRORS": {
    "CODE": 400,
    "DETAILS": "Oops, unable to fetch requested data (MPS821221457221625)"
  }
}

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "control_statistic_data_fetch",
    "STATUS": "FAILED"
  },
  "ERRORS": {
    "CODE": 400,
    "DETAILS": "Oops, you don't have the necessary permission for this request (MPS632645020971927)"
  }
}

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "control_statistic_data_fetch",
    "STATUS": "FAILED"
  },
  "ERRORS": {
    "CODE": 400,
    "DETAILS": "Oops, your request contains unsupport request type (MPS404030360019713)"
  }
}

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "control_statistic_data_fetch",
    "STATUS": "FAILED"
  },
  "ERRORS": {
    "CODE": 400,
    "DETAILS": "Could not process your request (MPS740874385863859)"
  }
}

System Daily Statistics

Retrieve daily performance metrics and statistics

GET

Description

This endpoint provides detailed day-by-day statistics for system activity and performance. It returns metrics on transactions, revenue, user activity, and other performance indicators broken down by individual days within the specified date range.

The daily breakdown makes this endpoint ideal for tracking trends, identifying patterns, and visualizing daily fluctuations in system activity. It's commonly used for generating charts, graphs, and time-series analyses.

Authentication is required for this endpoint with administrative privileges. You must include the required HMAC-based authentication headers.

Headers

Name	Value	Required	Description
MPY-SECUREKEY	{public_key}	Yes	Your public key obtained during login/registration
MPY-TIMESTAMP	{unix_timestamp}	Yes	Current unix timestamp in seconds
MPY-REQSIGNAL	{request_signature}	Yes	HMAC-SHA512 signature of the request
Content-Type	application/json	Yes	Administrator's access token

Query Parameters

Name	Type	Required	Description
page	string	No	Page number for pagination (default: 123456789001)

Request Example

GET /tp_daily_statistics?page=123456789001

Body:

{}

Success Response

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "tp_daily_statistics",
    "STATUS": "OK"
  },
  "DATA": {
    "result": [
      {
        "marker": "123456789001",
        "isocode": "NG",
        "flag": "https://example.com/flag.png",
        "country": "Nigeria",
        "newUsers": 0,
        "newVistor": 0,
        "activUser": 0,
        "tradCount": 0,
        "tradCompt": 0,
        "tradVolum": 0,
        "mobilephn": 0,
        "computers": 0,
        "perxStart": "123456789001",
        "perxEnds": "123456789001",
        "recorded": "123456789001"
      },
      {
        "marker": "123456789002",
        "isocode": "GH",
        "flag": "https://example.com/flag.png",
        "country": "Ghana",
        "newUsers": 0,
        "newVistor": 0,
        "activUser": 0,
        "tradCount": 0,
        "tradCompt": 0,
        "tradVolum": 0,
        "mobilephn": 0,
        "computers": 0,
        "perxStart": "123456789001",
        "perxEnds": "123456789001",
        "recorded": "123456789001"
      },
      {
        "marker": "123456789003",
        "isocode": "ZA",
        "flag": "https://example.com/flag.png",
        "country": "South Africa",
        "newUsers": 0,
        "newVistor": 0,
        "activUser": 0,
        "tradCount": 0,
        "tradCompt": 0,
        "tradVolum": 0,
        "mobilephn": 0,
        "computers": 0,
        "perxStart": "123456789001",
        "perxEnds": "123456789001",
        "recorded": "123456789001"
      }
    ],
    "pagination": "123456789001"
  }
}

Possible Error Responses

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "tp_daily_statistics",
    "STATUS": "FAILED"
  },
  "ERRORS": {
    "CODE": 401,
    "DETAILS": "Access Denied (MPS186244751624519)"
  }
}

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "tp_daily_statistics",
    "STATUS": "FAILED"
  },
  "ERRORS": {
    "CODE": 403,
    "DETAILS": "We couldn't find any record matching your query (MPS395142588394143)"
  }
}

System Country Statistics

Retrieve analytics data broken down by country

GET

Description

This endpoint provides analytics data grouped by country, showing metrics such as new users, visitors, active users, trade counts, trade volumes, and device types. The data is collected weekly and can be queried by country ISO code or time period.

The country statistics are automatically updated as users interact with the system and are organized by weekly periods for consistent reporting.

Authentication is required for this endpoint with administrative privileges. You must include the required HMAC-based authentication headers.

Headers

Name	Value	Required	Description
MPY-SECUREKEY	{public_key}	Yes	Your public key obtained during login/registration
MPY-TIMESTAMP	{unix_timestamp}	Yes	Current unix timestamp in seconds
MPY-REQSIGNAL	{request_signature}	Yes	HMAC-SHA512 signature of the request
Content-Type	application/json	Yes	Administrator's access token

Query Parameters

Name	Type	Required	Description
rtyp	string	No	Type of query. Options: "country", "period", "wstart", "wstop", or leave empty for all countries
reqv	string	No	Value for the query type. For "country" provide ISO code, for period/wstart/wstop provide timestamp

Request Example

GET /app_country_statistics?rtyp=country&reqv=ng

Body:

{}

Success Response

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "app_country_statistics",
    "STATUS": "OK"
  },
  "DATA": [
    {
      "marker": "MPS789456123",
      "isocode": "ng",
      "flag": "https://example.com/flags/ng.png",
      "country": "nigeria",
      "newUsers": 5642,
      "newVistor": 12489,
      "activUser": 8354,
      "tradCount": 8745,
      "tradCompt": 6512,
      "tradVolum": 4582750.25,
      "mobilephn": 9876,
      "computers": 2613,
      "perxStart": 1683723600,
      "perxEnds": 1684328400,
      "recorded": "1683723600"
    },
    {
      "marker": "MPS456789123",
      "isocode": "gh",
      "flag": "https://example.com/flags/gh.png",
      "country": "ghana",
      "newUsers": 1256,
      "newVistor": 3567,
      "activUser": 1892,
      "tradCount": 2341,
      "tradCompt": 1762,
      "tradVolum": 1254680.5,
      "mobilephn": 2785,
      "computers": 782,
      "perxStart": 1683723600,
      "perxEnds": 1684328400,
      "recorded": "1683723601"
    },
    {
      "marker": "MPS123456789",
      "isocode": "za",
      "flag": "https://example.com/flags/za.png",
      "country": "south africa",
      "newUsers": 3456,
      "newVistor": 2345,
      "activUser": 1234,
      "tradCount": 4567,
      "tradCompt": 3456,
      "tradVolum": 2345670.75,
      "mobilephn": 1234,
      "computers": 654,
      "perxStart": 1683723600,
      "perxEnds": 1684328400,
      "recorded": "1683723602"
    }
  ]
}

Possible Error Responses

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "app_country_statistics",
    "STATUS": "FAILED"
  },
  "ERRORS": {
    "CODE": 401,
    "DETAILS": "Authentication required. Please login. (MPS982163547892561)"
  }
}

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "app_country_statistics",
    "STATUS": "FAILED"
  },
  "ERRORS": {
    "DETAILS": "We couldn't find any record matching your query (MPS325199850343669)"
  }
}

User Activity

User Trade History

Retrieves transaction history for a specific user

GET

Description

This endpoint provides administrators with access to a user's transaction history. It allows for monitoring of user activities.

The data is paginated for efficient retrieval, with each response containing a pagination token that can be used to fetch the next set of records.

Administrative Resource

This endpoint requires the "viewHistory" permission in the "userControl" section.

Authentication is required for this endpoint with administrative privileges. You must include the required HMAC-based authentication headers.

Headers

Name	Value	Required	Description
MPY-SECUREKEY	{public_key}	Yes	Your public key obtained during login/registration
MPY-TIMESTAMP	{unix_timestamp}	Yes	Current unix timestamp in seconds
MPY-REQSIGNAL	{request_signature}	Yes	HMAC-SHA512 signature of the request
Content-Type	application/json	Yes	Administrator's access token. Admin access required.

Query Parameters

Name	Type	Required	Description
uxid	string	Yes	User ID to fetch transaction history for
page	string	No	Page number for pagination (default: 123456789001)

Request Example

GET /control_user_trade_history?uxid=MPS987654321&page=123456789001

Body:

{}

Success Response

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "control_user_trade_history",
    "STATUS": "OK"
  },
  "DATA": {
    "result": [
      {
        "marker": "MPS123456789",
        "userid": "MPS987654321",
        "tx_type": "deposit",
        "tx_amount": 150000,
        "tx_reference": "TX987654321",
        "payment_code": "BANK123",
        "customer_id": "CUS123456789",
        "customer_email": "customer@example.com",
        "customer_mobile": "+2348012345678",
        "biller_name": "Bank Name",
        "biller_item": "Item Name",
        "response_code": "200",
        "response_message": "Transaction successful",
        "recharge_pin": "123456",
        "misc_data": "Transaction details",
        "status": "pending",
        "recorded": "123456789001"
      },
      {
        "marker": "MPS567891234",
        "userid": "MPS987654321",
        "tx_type": "transfer",
        "tx_amount": 75000,
        "tx_reference": "TX123456789",
        "payment_code": "BANK456",
        "customer_id": "CUS456789123",
        "customer_email": "customer@example.com",
        "customer_mobile": "+2348012345678",
        "biller_name": "Bank Name",
        "biller_item": "Item Name",
        "response_code": "200",
        "response_message": "Transaction successful",
        "recharge_pin": "123456",
        "misc_data": "Transaction details",
        "status": "completed",
        "recorded": "123456789002"
      }
    ],
    "pagination": "123456789001"
  }
}

Possible Error Responses

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "control_user_trade_history",
    "STATUS": "FAILED"
  },
  "ERRORS": {
    "ID": "uxid_required",
    "DETAILS": "User account status is required (MPS251627402516272)"
  }
}

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "control_user_trade_history",
    "STATUS": "FAILED"
  },
  "ERRORS": {
    "DETAILS": "Could not find any data matching your request (MPS262716282617282)"
  }
}

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "control_user_trade_history",
    "STATUS": "FAILED"
  },
  "ERRORS": {
    "DETAILS": "Oops, you don't have the necessary permission for this request (MPS261729422516272)"
  }
}

User Trade Feedback

Retrieves user feedback and ratings for trade transactions, including comments and satisfaction metrics.

GET

Description

This endpoint provides administrators with access to user feedback and satisfaction ratings for trade transactions. It enables analysis of user experience, monitoring of service quality, and identification of areas for improvement in the trading process.

The response includes detailed feedback entries with ratings, comments, and associated trade information when possible.

User Experience Insights

This endpoint is particularly useful for:

Monitoring user satisfaction with trading experiences
Identifying common issues or pain points in the trading process
Discovering highly rated features or aspects of the service
Tracking satisfaction trends over time for service improvement

Authentication is required for this endpoint with administrative privileges. You must include the required HMAC-based authentication headers.

Headers

Name	Value	Required	Description
MPY-SECUREKEY	{public_key}	Yes	Your public key obtained during login/registration
MPY-TIMESTAMP	{unix_timestamp}	Yes	Current unix timestamp in seconds
MPY-REQSIGNAL	{request_signature}	Yes	HMAC-SHA512 signature of the request
Content-Type	application/json	Yes	Content type of the request

Query Parameters

Name	Type	Required	Description
rqsx	string	No	Feedback status (pending/approved/rejected)
page	integer	No	Page number for pagination (default: 123456789001)
pnum	integer	No	Number of results per page (default: 15, max: 100)

Request Example

GET /control_user_trade_feedback?rqsx=pending&page=123456789001&pnum=15

Body:

{}

Success Response

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "control_user_trade_feedback",
    "STATUS": "OK"
  },
  "DATA": {
    "result": [
      {
        "marker": "MPS123456789",
        "userid": "MPS987654321",
        "ipaddx": "192.168.1.1",
        "devname": "Chrome",
        "devType": "browser",
        "devNumr": "1234567890",
        "message": "This is a test message",
        "status": "pending",
        "recorded": "123456789001"
      },
      {
        "marker": "MPS567891234",
        "userid": "MPS987654321",
        "ipaddx": "192.168.1.2",
        "devname": "Firefox",
        "devType": "browser",
        "devNumr": "1234567891",
        "message": "Another test message",
        "status": "approved",
        "recorded": "123456789002"
      }
    ],
    "pagination": "123456789001"
  }
}

Possible Error Responses

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "control_user_trade_feedback",
    "STATUS": "FAILED"
  },
  "ERRORS": {
    "CODE": 403,
    "DETAILS": "Oops, you don't have the necessary permission for this request (MPS960308812453053)"
  }
}

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "control_user_trade_feedback",
    "STATUS": "FAILED"
  },
  "ERRORS": {
    "CODE": 404,
    "DETAILS": "Trade feedback status is required (MPS621145238882621)"
  }
}

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "control_user_trade_feedback",
    "STATUS": "FAILED"
  },
  "ERRORS": {
    "CODE": 500,
    "DETAILS": "Could not find any data matching your request (MPS652714855617547)"
  }
}

System Monitoring

Fetch System Logs

Retrieve system logs for monitoring and troubleshooting

GET

Description

This endpoint provides access to system logs that help administrators monitor the health of the application and troubleshoot issues. Logs include errors, warnings, and other system events with timestamps and contextual information.

The response is paginated to handle large volumes of logs efficiently. Use the pagination token from each response to fetch the next set of records.

Authentication is required for this endpoint with administrative privileges. You must include the required HMAC-based authentication headers.

Headers

Name	Value	Required	Description
MPY-SECUREKEY	{public_key}	Yes	Your public key obtained during login/registration
MPY-TIMESTAMP	{unix_timestamp}	Yes	Current unix timestamp in seconds
MPY-REQSIGNAL	{request_signature}	Yes	HMAC-SHA512 signature of the request
Content-Type	application/json	Yes	Administrator's access token. Admin access required.

Query Parameters

Name	Type	Required	Description
rqtp	string	No	The type of system logs to fetch (mtype, mk, all)
rqvl	string	No	Value for filtering logs based on rqtp
page	string	No	Page number for pagination (default: 123456789001)

Request Example

GET /other_system_log_fetch?rqtp=error&page=123456789001

Body:

{}

Success Response

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "other_system_log_fetch",
    "STATUS": "OK"
  },
  "DATA": {
    "result": [
      {
        "marker": "MPS123456789",
        "mtype": "error",
        "descrpt": "Database connection timed out",
        "status": "open",
        "recorded": "123456789001"
      },
      {
        "marker": "MPS987654321",
        "mtype": "warning",
        "descrpt": "High CPU load detected",
        "status": "resolved",
        "recorded": "123456789002"
      },
      {
        "marker": "MPS567891234",
        "mtype": "info",
        "descrpt": "System startup complete",
        "status": "closed",
        "recorded": "123456789003"
      }
    ],
    "pagination": "123456789001"
  }
}

Possible Error Responses

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "other_system_log_fetch",
    "STATUS": "FAILED"
  },
  "ERRORS": {
    "DETAILS": "Request type is required (MPS333748543758643)"
  }
}

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "other_system_log_fetch",
    "STATUS": "FAILED"
  },
  "ERRORS": {
    "DETAILS": "The request made does not correspond to any item found by the server (MPS753221844219357)"
  }
}

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "other_system_log_fetch",
    "STATUS": "FAILED"
  },
  "ERRORS": {
    "DETAILS": "Oops, you don't have the necessary permission for this request (MPS239727771625449)"
  }
}

Resolve System Log

Marks a system log as resolved or ignored after addressing the underlying issue.

GET

Description

This endpoint allows administrators to update the status of system logs after investigating and addressing the underlying issues. It supports marking logs as either resolved (when the issue has been fixed) or ignored (when the issue is deemed not actionable or a false alarm).

Issue Resolution Workflow

This endpoint is typically used as part of the system monitoring workflow:

Administrators identify issues through the Fetch System Logs endpoint
They investigate the underlying causes and apply necessary fixes
They use this endpoint to mark the log as resolved and document the solution

Authentication is required for this endpoint with administrative privileges. You must include the required HMAC-based authentication headers.

Headers

Name	Value	Required	Description
MPY-SECUREKEY	{public_key}	Yes	Your public key obtained during login/registration
MPY-TIMESTAMP	{unix_timestamp}	Yes	Current unix timestamp in seconds
MPY-REQSIGNAL	{request_signature}	Yes	HMAC-SHA512 signature of the request
Content-Type	application/json	Yes	Content type of the request

Query Parameters

Name	Type	Required	Description
lxid	string	Yes	Unique identifier of the system log to resolve

Request Example

GET /other_system_log_resolve?lxid=6453d5243546576g8

Body:

{}

Success Response

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "other_system_log_resolve",
    "STATUS": "OK"
  },
  "DATA": {
    "COMMENT": "System log resolved successfully!"
  }
}

Possible Error Responses

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "other_system_log_resolve",
    "STATUS": "FAILED"
  },
  "ERRORS": {
    "CODE": 400,
    "DETAILS": "System log tracking ID is required (MPS899698148626441)"
  }
}

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "other_system_log_resolve",
    "STATUS": "FAILED"
  },
  "ERRORS": {
    "CODE": 403,
    "DETAILS": "Could not process your request (MPS167638985064267)"
  }
}

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "other_system_log_resolve",
    "STATUS": "FAILED"
  },
  "ERRORS": {
    "CODE": 404,
    "DETAILS": "Oops, you don't have the necessary permission for this request (MPS149982221286978)"
  }
}

Fetch System Feedback

Retrieves user feedback about system features and functionality for product improvement.

GET

Description

This endpoint provides administrators with access to user feedback about different features and aspects of the system. It enables monitoring of user satisfaction, identifying areas for improvement, and tracking product enhancement requests.

Product improvement insights and use cases:

Gathering user insights to inform product development
Identifying pain points and friction in the user experience
Discovering feature requests and enhancement opportunities
Monitoring user satisfaction across different parts of the application

Authentication is required for this endpoint with administrative privileges. You must include the required HMAC-based authentication headers.

Headers

Name	Value	Required	Description
MPY-SECUREKEY	{public_key}	Yes	Your public key obtained during login/registration
MPY-TIMESTAMP	{unix_timestamp}	Yes	Current unix timestamp in seconds
MPY-REQSIGNAL	{request_signature}	Yes	HMAC-SHA512 signature of the request
Content-Type	application/json	Yes	Content type of the request

Query Parameters

Name	Type	Required	Description
rqtp	string	Yes	The type of tutorial to fetch (user, status, mk, all)
rqvl	string	No	The marker ID of a specific tutorial to retrieve
page	integer	No	Page number for pagination (default: 123456789001)

Request Example

GET /other_system_feedback_fetch?rqtp=all&page=123456789001

Body:

{}

Success Response

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "other_system_feedback_fetch",
    "STATUS": "OK"
  },
  "DATA": {
    "result": [
      {
        "marker": "g43d4f56g5f67h876",
        "userid": "user_123456789001",
        "ipaddx": "192.168.1.1",
        "devname": "John Doe",
        "devType": "mobile",
        "devNumr": "+2348060000000",
        "message": "I'm having trouble logging in to my account. The login page is not loading properly.",
        "status": "pending",
        "recorded": "123456789001"
      },
      {
        "marker": "g43d4f56g5f67h876",
        "userid": "user_123456789001",
        "ipaddx": "192.168.1.1",
        "devname": "John Doe",
        "devType": "mobile",
        "devNumr": "+2348060000000",
        "message": "I'm having trouble logging in to my account. The login page is not loading properly."
      }
    ],
    "pagination": "123456789001"
  }
}

Possible Error Responses

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "other_system_feedback_fetch",
    "STATUS": "FAILED"
  },
  "ERRORS": {
    "CODE": 401,
    "DETAILS": "We couldn't find any record matching your query (MPS610734685990776)"
  }
}

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "other_system_feedback_fetch",
    "STATUS": "FAILED"
  },
  "ERRORS": {
    "CODE": 400,
    "DETAILS": "Oops, you don't have the necessary permission for this request (MPS448472768124470)"
  }
}

Customer Communications

Fetch Contact Forms (Admin)

Retrieve customer contact form submissions with management data

GET

Description

This endpoint retrieves customer contact form submissions with additional administrative data for customer support management. It provides detailed information about each submission, including status, assignment, and resolution information.

Administrative Access

This endpoint requires administrative privileges and should only be accessed by authorized support staff and administrators.

Authentication is required for this endpoint with administrative privileges. You must include the required HMAC-based authentication headers.

Headers

Name	Value	Required	Description
MPY-SECUREKEY	{public_key}	Yes	Your public key obtained during login/registration
MPY-TIMESTAMP	{unix_timestamp}	Yes	Current unix timestamp in seconds
MPY-REQSIGNAL	{request_signature}	Yes	HMAC-SHA512 signature of the request

Query Parameters

Name	Type	Required	Description
rqtp	string	Yes	The type of tutorial to fetch (email, mk, all)
rqvl	string	No	The marker ID of a specific tutorial to retrieve
page	integer	No	Page number for pagination (default: 123456789001)

Request Example

GET /other_contact_form_fetch?rqtp=all&page=123456789001

Body:

{}

Success Response

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "other_contact_form_fetch",
    "STATUS": "OK"
  },
  "DATA": {
    "result": [
      {
        "marker": "763545876653x3x47g67",
        "name": "John Doe",
        "email": "john.doe@example.com",
        "subject": "Payment Issue",
        "message": "I've been trying to make a payment but keep getting an error message. Can you help?",
        "ipaddx": "192.168.1.123",
        "devname": "iphone 12 pro max",
        "devType": "mobile",
        "devNumr": "76543543546576798756354453467",
        "status": "pending",
        "recorded": "123456789001"
      },
      {
        "marker": "76465ff4578576365456",
        "name": "Jane Smith",
        "email": "jane.smith@example.com",
        "subject": "Account Verification Problem",
        "message": "I submitted my verification documents 3 days ago but my account is still unverified.",
        "ipaddx": "192.168.1.124",
        "devname": "iphone 15 pro max",
        "devType": "mobile",
        "devNumr": "3435456453453546576554347665",
        "status": "pending",
        "recorded": "123456789002"
      }
    ],
    "pagination": "123456789001"
  }
}

Possible Error Responses

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "other_contact_form_fetch",
    "STATUS": "FAILED"
  },
  "ERRORS": {
    "CODE": 401,
    "DETAILS": "Request type is required (MPS135953118008387)"
  }
}

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "other_contact_form_fetch",
    "STATUS": "FAILED"
  },
  "ERRORS": {
    "CODE": 400,
    "DETAILS": "We couldn't find any record matching your query (MPS213462423458097)"
  }
}

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "other_contact_form_fetch",
    "STATUS": "FAILED"
  },
  "ERRORS": {
    "CODE": 400,
    "DETAILS": "Oops, you don't have the necessary permission for this request (MPS590100916034078)"
  }
}

Fetch Newsletter List

Retrieve newsletter subscription data with analytics

GET

Description

This endpoint retrieves a comprehensive list of newsletter subscribers along with engagement metrics. It provides detailed information about each subscriber, including subscription status, engagement rates, and geographic information.

The response includes aggregated metrics such as total active subscribers, unsubscribe rate, and average engagement statistics to help analyze newsletter performance.

Administrative Access

This endpoint requires administrative privileges and should only be accessed by authorized personnel for analytics and marketing purposes.

Authentication is required for this endpoint with administrative privileges. You must include the required HMAC-based authentication headers.

Headers

Name	Value	Required	Description
MPY-SECUREKEY	{public_key}	Yes	Your public key obtained during login/registration
MPY-TIMESTAMP	{unix_timestamp}	Yes	Current unix timestamp in seconds
MPY-REQSIGNAL	{request_signature}	Yes	HMAC-SHA512 signature of the request

Query Parameters

Name	Type	Required	Description
rqtp	string	No	The type of newsletter list to fetch (email, mk, all)
rqvl	string	No	Value for filtering logs based on rqtp
page	string	No	Page number for pagination (default: 123456789001)

Request Example

GET /other_newsletter_fetch?rqtp=email&page=123456789001

Body:

{}

Success Response

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "other_newsletter_fetch",
    "STATUS": "OK"
  },
  "DATA": {
    "result": [
      {
        "marker": "763545876653x3x47g67",
        "email": "johndoe@example.com",
        "recorded": "123456789001"
      },
      {
        "marker": "76465ff4578576365456",
        "email": "janedoe@example.com",
        "recorded": "123456789002"
      },
      {
        "marker": "76543543546576798756354453467",
        "email": "michaeljohnson@example.com",
        "recorded": "123456789003"
      }
    ],
    "pagination": "123456789001"
  }
}

Possible Error Responses

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "other_newsletter_fetch",
    "STATUS": "FAILED"
  },
  "ERRORS": {
    "CODE": 401,
    "DETAILS": "Request type is required (MPS897522375970954)"
  }
}

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "other_newsletter_fetch",
    "STATUS": "FAILED"
  },
  "ERRORS": {
    "CODE": 400,
    "DETAILS": "The request made does not correspond to any item found by the server (MPS931757682131473)"
  }
}

{
  "REQUEST": {
    "VERSION": "1.0",
    "ACTION": "other_newsletter_fetch",
    "STATUS": "FAILED"
  },
  "ERRORS": {
    "CODE": 400,
    "DETAILS": "Oops, you don't have the necessary permission for this request (MPS993685835777144)"
  }
}