MLController API Documentation

Machine Learning API Documentation

This document provides documentation for the Machine Learning (ML) API endpoints available in the Points.Api system.

Table of Contents

• Authentication
• Endpoints
  • Get Partner Flags

Authentication

All endpoints in the ML API require JWT Bearer authentication. Include the JWT token in the Authorization header of your requests:

Authorization: Bearer {your_jwt_token}

Endpoints

Get Partner Flags

Retrieves machine learning prediction results for a specific partner and board.

URL: /api/ML/{partnerId}/board/{boardId}

Method: GET

Auth required: Yes (JWT Bearer token)

URL Parameters:

• partnerId (long) - ID of the partner
• boardId (long) - ID of the board

Success Response:

• Code: 200 OK
• Content: Prediction results

Example Request:

GET /api/ML/123/board/456 HTTP/1.1
Host: your-api-domain.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Example Response:

{
  "predictions": []
}

Notes:

• This endpoint appears to be a placeholder or under development, as the implementation returns an empty result.
• The endpoint is designed to provide machine learning prediction results for leaderboards or other partner-specific data.