NEEDS TO NOW BE UPDATED for v0.04. The /process and /update API endpoints allow you to send a post for moderation, review, improvement, and update the post in Gainsight. Here is a detailed explanation of how to use them:

Endpoint: POST /api/process

Headers:

• X-API-Key: Your API key obtained from your Moderate Kit account.
• Content-Type: application/json
• Authorization: Bearer token for authenticating with Gainsight.

Body: The request body should be a JSON object with the following fields:

{
  "post_topic": "Sample Topic",
  "post_title": "Sample Title",
  "post_description": "Sample Description",
  "post_tags": "tag1, tag2",
  "code_of_conduct": "Community Code of Conduct",
  "record_id": "record_id",
  "post_category": "Sample Category",
  "predetermined_topics": "topic1, topic2",
  "predetermined_categories": "category1, category2",
  "predetermined_tags": "tag1, tag2"
}
        

Response: The API will return the updated post data after moderation.

{
  "record_id": "record_id",
  "topic": "Improved Topic",
  "title": "Improved Title",
  "description": "Improved Description",
  "category": "Improved Category",
  "tags": "tag1, tag2",
  "moderation_status_title": {...},
  "moderation_score_title": 0,
  "moderation_evaluation_title": "Evaluation details",
  "moderation_status_description": {...},
  "moderation_score_description": 0,
  "moderation_evaluation_description": "Evaluation details",
  "combined_scores": {...},
  "combined_overall_score": 0,
  "url_evaluations": [...],
  "moderator_labels": "Moderation by ModerateKit v0.05: Approved, Moderated at: timestamp",
  "moderator_tags": "tag1, tag2, PII",
  "moderation_status": "Approve/Mark as Spam/Trash"
}
        

Endpoint: POST /api/update

Headers:

• X-API-Key: Your API key obtained from your Moderate Kit account.
• Content-Type: application/json
• Authorization: Bearer token for authenticating with Gainsight.

Body: The request body should be a JSON object with the following fields:

{
  "record_id": "record_id",
  "topic": "Improved Topic",
  "title": "Improved Title",
  "description": "Improved Description",
  "category": "Improved Category",
  "tags": "tag1, tag2",
  "moderation_status": "Approve/Mark as Spam/Trash",
  "moderator_labels": "Moderation by ModerateKit v0.1: Approved, Moderated at: timestamp",
  "moderator_tags": "tag1, tag2, PII",
  "moderation_status_title": {...},
  "moderation_score_title": 0,
  "moderation_evaluation_title": "Evaluation details",
  "moderation_status_description": {...},
  "moderation_score_description": 0,
  "moderation_evaluation_description": "Evaluation details",
  "combined_scores": {...},
  "combined_overall_score": 0,
  "url_evaluations": [...]
}
        

Response: The API will return a success message upon updating the Gainsight record.

{
  "status": "success",
  "message": "Gainsight record updated successfully"
}