Offers

An offer here is one this publication has joined from the Offers Directory. Use this resource to list the offers a publication is recommending, fetch a single one by UUID, archive, re-activate, and read the conversions recorded against each. Omit status on the list to exclude archived rows.

List offers

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

Paginated. Omit status to list non-archived rows.

Path Parameters

Name

Type

Description

publication_uuid*

String

The publication's UUID.

Query Parameters

Name

Type

Description

status

String

Optional filter: active or archived. Omit for all non-archived. Invalid → 400.

expand

String

stats to include performance.

from

String

Start date (YYYY-MM-DD) for stats.

String

End date (YYYY-MM-DD) for stats.

{
  "offers": [
    <Offer Recommendation Object>
  ],
  "meta": {
    "per_page": 50,
    "page": 1,
    "total_pages": 1,
    "total_offers": 5
  }
}

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

Get offer

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

Path Parameters

Name

Type

Description

publication_uuid*

String

The publication's UUID.

uuid*

String

The offer's UUID.

{
  "offer": <Offer Recommendation Object>
}

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

Archive an offer

POST https://api.sparkloop.app/v3/publications/:publication_uuid/earn/offers/:offer_uuid/archive

Soft-archives the joined offer 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.

offer_uuid*

String

The offer's UUID.

{
  "offer": <Offer Recommendation Object>
}

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

Re-activate an offer

POST https://api.sparkloop.app/v3/publications/:publication_uuid/earn/offers/:offer_uuid/reactivation

Restores a soft-archived joined offer. Only works when this publication (the partner) archived it. If the brand archived it, the request returns 422.

Path Parameters

Name

Type

Description

publication_uuid*

String

The publication's UUID.

offer_uuid*

String

The offer's UUID.

{
  "offer": <Offer Recommendation Object>
}

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

{
  "error": "You are not allowed to reactivate this offer"
}

List conversions

GET https://api.sparkloop.app/v3/publications/:publication_uuid/earn/offers/:offer_uuid/conversions

Paginated, newest first.

Path Parameters

Name

Type

Description

publication_uuid*

String

The publication's UUID.

offer_uuid*

String

The offer's UUID.

{
  "conversions": [
    <Offer Conversion Object>
  ],
  "meta": {
    "per_page": 50,
    "page": 1,
    "total_pages": 2,
    "total_conversions": 73
  }
}

PreviousOffers NextTools