Recommendations

Get recommendation

GET https://api.sparkloop.app/v2/partner_profile/partner_campaigns/:identifier

Path Parameters

Name	Type	Description
identifier*	String	Recommendation's UUID

200: OK

{
  "partner_campaign": {
    "uuid": "partner_campaign_a6224cd65cf3",
    "publication_uuid": "pub_5fc782e24409",
    "partner_profile_uuid": "partner_df80bd29bf34",
    "status": "draft",
    "referral_link": "http://link.sparkloop.eu.ngrok.io/p/c3088257c7",
    "cpa": 2.0,
    "max_payout": 500.0,
    "partner_program_uuid": "partner_program_abcdef123",
    "campaign_type": null,
    "thankyou_page_url": null,
    "accepted_terms_at": null,
    "name": "My partner campaign",
    "referral_pending_period": null
  }
}

404: Not Found

{
    // Response
}

Get recommendations

GET https://api.sparkloop.app/v2/partner_profile/partner_campaigns

200: OK

{
  "partner_campaigns": [
    {
      "uuid": "partner_campaign_a6224cd65cf3",
      "publication_uuid": "pub_5fc782e24409",
      "partner_profile_uuid": "partner_df80bd29bf34",
      "status": "draft",
      "referral_link": "http://sparkloop.app/p/c3088257c7",
      "cpa": 2.0,
      "max_payout": 500.0,
      "partner_program_uuid": "partner_program_abcdef123",
      "campaign_type": null,
      "thankyou_page_url": null,
      "accepted_terms_at": null,
      "name": "My partner campaign",
      "referral_pending_period": null
    },
    {
      "uuid": "partner_campaign_1232424",
      "publication_uuid": "pub_5fc782e24409",
      "partner_profile_uuid": "partner_df80bd29bf34",
      "status": "draft",
      "referral_link": "http://sparkloop.app/p/abcde8257c7",
      "cpa": 2.0,
      "max_payout": 500.0,
      "partner_program_uuid": "partner_program_abcdef123",
      "campaign_type": null,
      "thankyou_page_url": null,
      "accepted_terms_at": null,
      "name": "My partner campaign",
      "referral_pending_period": null
    }
  ],
  "meta": {
    "per_page": 3,
    "page": 2,
    "total_pages": 12,
    "total_partner_campaigns": 36
  }    
}

Get partner campaign referrals

GET https://api.sparkloop.app/v2/partner_profile/partner_campaigns/:identifier/referrals

Path Parameters

Name	Type	Description
identifier*	String	Recommendation's UUID

Query Parameters

Name	Type	Description
referrals_status	String	Only return referrals of a specified status. Available options are confirmed, pending, or rejected. The default is confirmed

200: OK

{
    "subscribers": [
      {
        "uuid": "sub_4bc1056297",
        "email": "[e-mail]",
        "name": null,
        "ref_code": "c784ef4f",
        "referrer_code": null,
        "referred": true,
        "referral_status": "verified",
        "ip_address": null,
        "user_agent": null,
        "origin": "signup",
        "utm_source": null,
        "utm_campaign": null,
        "created_at": "2021-03-24T11:55:02.113Z"
      },
      {
        "uuid": "sub_869976268c",
        "email": "[e-mail]",
        "name": null,
        "ref_code": "d163ac6e",
        "referrer_code": null,
        "referred": false,
        "referral_status": "verified",
        "ip_address": null,
        "user_agent": null,
        "origin": "signup",
        "utm_source": null,
        "utm_campaign": null,
        "created_at": "2021-03-24T11:55:02.096Z"
        }
    ],
    "meta": {
      "per_page": 3,
      "page": 2,
      "total_pages": 12,
      "total_subscribers": 36
    }
}

Archive recommendation

Use this endpoint to archive a recommendation.

DELETE https://api.sparkloop.app/v2/partner_profile/partner_campaigns/:identifier

Path Parameters

Name	Type	Description
identifier*	String	Recommendation's UUID

Response

200

{
  "recommendation": <Recommendation Object>
}

Reactivate recommendation

Use this endpoint to restore an archived recommendation, unless it was archived by a sponsor, in which case reactivation is not possible.

PUT https://api.sparkloop.app/v2/partner_profile/partner_campaigns/:identifier/reactivate

Path Parameters

Name	Type	Description
identifier*	String	Recommendation's UUID

Response

200

{
  "recommendation": <Recommendation Object>
}

422

{
  "error": "This recommendation was archived by the sponsor and can't be re-activated."
}