Summary

  • The ContentWRX Effectiveness API is a REST API utilizing API key-based authentication. 

  • API keys are associated with your account. To change your key, please contact support.

  • The domain for the API is “https://effectiveness.contentwrx.com/api/partner”

  • Endpoints are listed below

Authentication

  • Authentication is accomplished through the “Authorization” header

  • The “Authorization” header should be set to “Bearer {your api key}”

  • Your API key can be found in the “Manage” section of the web application while viewing an evaluation.

Endpoints

  • GET /evaluations

    • Returns all evaluations for an account

  • GET /evaluations/:id

    • Returns a specific evaluation with the given id

  • GET /evaluations/:id/text_answers

    • Returns a list of text answers for the evaluation with the given id

    • Query params

      • year

        • Year for the text answers

        • Format YYYY

        • Required

      • month

        • Month for the text answers

        • Format M (1, 2, 3 …. 10, 11, 12)

        • Required

  • GET /evaluations/:id/recommendations

    • Returns a list of recommendations for the evaluation with the given id

    • Query params

      • year

        • Year for the recommendations

        • Format YYYY

        • Required

      • month

        • Month for the recommendations

        • Format M (1, 2, 3 …. 10, 11, 12)

        • Required