Recommendations

Recommendations

A paid recommendation is a partner-program-backed recommendation this publication earns a commission from (the Earn side). Use this resource to list the paid recommendations the publication is currently making, fetch a single one by UUID, archive, or re-activate. Browse and recommend new programs from the Directory sub-resource; free recommendations live under Grow.

List recommendations

GET https://api.sparkloop.app/v3/publications/:publication_uuid/earn/recommendations

Paginated. Omit status to list non-archived rows (active + awaiting_approval).

Path Parameters

Name	Type	Description
publication_uuid*	String	The publication's UUID.

Query Parameters

Name	Type	Description
status	String	Optional filter: active (recommendable with budget), budget_used_up, paused, awaiting_approval, or archived. Omit for all non-archived. Invalid → 400.
expand	String	recommended_publication, stats.
from	String	Start date (YYYY-MM-DD) for stats.
to	String	End date (YYYY-MM-DD) for stats.

200: OK

{
  "recommendations": [
    <Recommendation Object>
  ],
  "meta": {
    "per_page": 50,
    "page": 1,
    "total_pages": 1,
    "total_recommendations": 8
  }
}

400: Bad Request

{
  "error": "Unsupported `status`. Valid values: active, budget_used_up, paused, awaiting_approval, archived."
}

Get recommendation

GET https://api.sparkloop.app/v3/publications/:publication_uuid/earn/recommendations/:uuid

Path Parameters

Name	Type	Description
publication_uuid*	String	The publication's UUID.
uuid*	String	The recommendation's UUID.

Query Parameters

Name	Type	Description
expand	String	recommended_publication, stats.

200: OK

{
  "recommendation": <Recommendation Object>
}

404: Not Found

{
  "error": "Resource not found."
}

Archive a recommendation

POST https://api.sparkloop.app/v3/publications/:publication_uuid/earn/recommendations/:recommendation_uuid/archive

Soft-archives the paid recommendation so it stops appearing in active lists. Reversible with re-activate when this publication (the partner) archived it.

Path Parameters

Name	Type	Description
publication_uuid*	String	The publication's UUID.
recommendation_uuid*	String	The recommendation's UUID.

200: OK

{
  "recommendation": <Recommendation Object>
}

404: Not Found

{
  "error": "Resource not found."
}

Re-activate a recommendation

POST https://api.sparkloop.app/v3/publications/:publication_uuid/earn/recommendations/:recommendation_uuid/reactivation

Restores a soft-archived paid recommendation. Only works when this publication (the partner) archived it.

Path Parameters

Name	Type	Description
publication_uuid*	String	The publication's UUID.
recommendation_uuid*	String	The recommendation's UUID.

200: OK

{
  "recommendation": <Recommendation Object>
}

404: Not Found

{
  "error": "Resource not found."
}

422: Unprocessable Entity

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