Retrieves the collection of Format resources.

GET

/api/offers

GET

/api/offers

curl -X GET "/api/offers" \
  -H "apikey: $MEDIALISTER_API_KEY"

Authorization

apikey
string
header
required
Value for the apikey header parameter.

Parameters

page
integer
query
The collection page number
Default:
1
itemsPerPage
integer
query
The number of items per page
Default:
10
q
string
query
Free text search query (e.g. publisher name, single domain), or a comma/semicolon/newline-separated list of domains to look up at once (max 200 domains per request)
formatType
string
query
Format type name filter (e.g. "Article"). Accepts a comma- or pipe-separated list for OR semantics
mediaType
string
query
Media type name filter (e.g. "Blog", "News"). Accepts a comma- or pipe-separated list for OR semantics
mediaCategory
string
query
Media category name filter (e.g. "Technology"). Accepts a comma- or pipe-separated list for OR semantics
mediaAudience
string
query
Media audience name filter. Accepts a comma- or pipe-separated list for OR semantics
location
string
query
Location name filter (e.g. "Miami", "United States"). Accepts a comma- or pipe-separated list for OR semantics
language
string
query
Language code filter (e.g. "en", "es"). Accepts a comma- or pipe-separated list for OR semantics
mediaBadge
string
query
Media badge name filter. Accepts a comma- or pipe-separated list for OR semantics
formatBadge
string
query
Format badge name filter. Accepts a comma- or pipe-separated list for OR semantics
audienceByCountry
string
query
Leading audience country name filter (e.g. "United States"). Accepts a comma- or pipe-separated list for OR semantics
acceptedTopic
string
query
Sensitive topic that must be accepted (e.g. "Crypto", "Gambling"). Accepts a comma- or pipe-separated list for OR semantics
hyperlinksType
string
query
Hyperlinks type filter: "do-follow", "no-follow", or "sponsored-hyperlinks". Accepts a comma- or pipe-separated list for OR semantics
textCondition
string
query
Text condition filter: "changes-in-text-are-possible", "text-without-changes", "text-by-author", or "text-by-author-paid". Accepts a comma- or pipe-separated list for OR semantics
adLabel
string
query
Ad label filter: "with-adv-mark", "without-adv-mark", "adv-mark-may-be-added", or "without-ad-label-fee". Accepts a comma- or pipe-separated list for OR semantics
priceMin
integer
query
Minimum price in USD
priceMax
integer
query
Maximum price in USD
audienceMin
integer
query
Minimum audience
audienceMax
integer
query
Maximum audience
ahrefsDrMin
integer
query
Minimum Ahrefs DR
ahrefsDrMax
integer
query
Maximum Ahrefs DR
semrushTrafficMin
integer
query
Minimum Semrush organic traffic
semrushTrafficMax
integer
query
Maximum Semrush organic traffic
maiMin
integer
query
Minimum Medialister Attention Index (MAI)
maiMax
integer
query
Maximum Medialister Attention Index (MAI)
ratingMin
integer
query
Minimum rating
ratingMax
integer
query
Maximum rating
estimatedViewsMin
integer
query
Minimum estimated views
estimatedViewsMax
integer
query
Maximum estimated views
successRateMin
integer
query
Minimum Success Rate (0-100). Media with no resolved orders (null rate) are excluded when this filter is active
successRateMax
integer
query
Maximum Success Rate (0-100). Media with no resolved orders (null rate) are excluded when this filter is active
turnAroundTimeMax
integer
query
Maximum turnaround time in days
hyperlinksAmountMin
integer
query
Minimum number of hyperlinks allowed
homePageAnnounce
boolean
query
Only offers with homepage announcement placement
permanentPlacement
boolean
query
Only offers with permanent placement
pageIndex
boolean
query
Only offers with page indexing
uniqueText
boolean
query
Only offers requiring unique text
withVideo
boolean
query
Only offers with video support
sortBy
string
query
Sort field: "price", "name", "turnAroundTime", "createdAt", "updatedAt", "audience", "ahrefsDr", "semrushOrganicTraffic", "rating", "estimatedViews", "mai", "successRate". Media with no resolved orders (null Success Rate) sort last regardless of direction. Defaults to newest first ("createdAt" desc) when no full-text query is given
sortOrder
string
query
Sort order: "asc" or "desc" (default "asc")
perPage
integer
query
Results per page (default 10, max 100)

Response

application/ld+json200

Format collection

hydra:totalItems
integer
hydra:search
object
hydra:view
object
hydra:member
Format.jsonld-offer.read[]
required

{
  "hydra:totalItems": 0,
  "hydra:search": {
    "@type": "string",
    "hydra:template": "string",
    "hydra:variableRepresentation": "string",
    "hydra:mapping": [
      {
        "@type": "string",
        "variable": "string",
        "property": "string",
        "required": true
      }
    ]
  },
  "hydra:view": {
    "@id": "string",
    "@type": "string",
    "hydra:first": "string",
    "hydra:last": "string",
    "hydra:previous": "string",
    "hydra:next": "string"
  },
  "hydra:member": [
    {
      "@context": "string",
      "@id": "string",
      "@type": "string",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "formatType": "/api/format_types/b64ed0ca-1a05-4898-9a52-765fed38bc5c",
      "mediaProject": "/api/media_projects/b64ed0ca-1a05-4898-9a52-765fed38bc5c",
      "price": 100.1,
      "urlExamples": [
        "string"
      ],
      "seoMetric": {
        "@context": "string",
        "@id": "string",
        "@type": "string",
        "audience": 0,
        "audienceSourceDirect": 0,
        "audienceSourceReferrals": 0,
        "audienceSourceSearch": 0,
        "audienceSourceSocial": 0,
        "sourceDirect": 0,
        "sourceReferrals": 0,
        "sourceSearch": 0,
        "sourceSocial": 0,
        "sourceDisplay": 0,
        "sourceMail": 0,
        "ahrefsDr": 0,
        "semrushOrganicTraffic": 0,
        "semrushAuthorityScore": 0,
        "organicTrafficByAhrefs": 0,
        "estimatedViews": 0,
        "leadingCountries": {
          "key": "string"
        },
        "bounceRate": 0,
        "timeOnSite": 0,
        "pagePerVisit": 0,
        "mai": 0,
        "visits": {
          "string": "string"
        }
      }
    }
  ]
}

GET

/api/offers

curl -X GET "/api/offers" \
  -H "apikey: $MEDIALISTER_API_KEY"

{
  "hydra:totalItems": 0,
  "hydra:search": {
    "@type": "string",
    "hydra:template": "string",
    "hydra:variableRepresentation": "string",
    "hydra:mapping": [
      {
        "@type": "string",
        "variable": "string",
        "property": "string",
        "required": true
      }
    ]
  },
  "hydra:view": {
    "@id": "string",
    "@type": "string",
    "hydra:first": "string",
    "hydra:last": "string",
    "hydra:previous": "string",
    "hydra:next": "string"
  },
  "hydra:member": [
    {
      "@context": "string",
      "@id": "string",
      "@type": "string",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "formatType": "/api/format_types/b64ed0ca-1a05-4898-9a52-765fed38bc5c",
      "mediaProject": "/api/media_projects/b64ed0ca-1a05-4898-9a52-765fed38bc5c",
      "price": 100.1,
      "urlExamples": [
        "string"
      ],
      "seoMetric": {
        "@context": "string",
        "@id": "string",
        "@type": "string",
        "audience": 0,
        "audienceSourceDirect": 0,
        "audienceSourceReferrals": 0,
        "audienceSourceSearch": 0,
        "audienceSourceSocial": 0,
        "sourceDirect": 0,
        "sourceReferrals": 0,
        "sourceSearch": 0,
        "sourceSocial": 0,
        "sourceDisplay": 0,
        "sourceMail": 0,
        "ahrefsDr": 0,
        "semrushOrganicTraffic": 0,
        "semrushAuthorityScore": 0,
        "organicTrafficByAhrefs": 0,
        "estimatedViews": 0,
        "leadingCountries": {
          "key": "string"
        },
        "bounceRate": 0,
        "timeOnSite": 0,
        "pagePerVisit": 0,
        "mai": 0,
        "visits": {
          "string": "string"
        }
      }
    }
  ]
}

Retrieves the collection of Format resources. - Medialister Help Center

API referenceFormat

Retrieves the collection of Format resources.

GET

/api/offers

GET

/api/offers

curl -X GET "/api/offers" \
  -H "apikey: $MEDIALISTER_API_KEY"

Authorization

apikey
string
header
required
Value for the apikey header parameter.

Parameters

page
integer
query
The collection page number
Default:
1
itemsPerPage
integer
query
The number of items per page
Default:
10
q
string
query
Free text search query (e.g. publisher name, single domain), or a comma/semicolon/newline-separated list of domains to look up at once (max 200 domains per request)
formatType
string
query
Format type name filter (e.g. "Article"). Accepts a comma- or pipe-separated list for OR semantics
mediaType
string
query
Media type name filter (e.g. "Blog", "News"). Accepts a comma- or pipe-separated list for OR semantics
mediaCategory
string
query
Media category name filter (e.g. "Technology"). Accepts a comma- or pipe-separated list for OR semantics
mediaAudience
string
query
Media audience name filter. Accepts a comma- or pipe-separated list for OR semantics
location
string
query
Location name filter (e.g. "Miami", "United States"). Accepts a comma- or pipe-separated list for OR semantics
language
string
query
Language code filter (e.g. "en", "es"). Accepts a comma- or pipe-separated list for OR semantics
mediaBadge
string
query
Media badge name filter. Accepts a comma- or pipe-separated list for OR semantics
formatBadge
string
query
Format badge name filter. Accepts a comma- or pipe-separated list for OR semantics
audienceByCountry
string
query
Leading audience country name filter (e.g. "United States"). Accepts a comma- or pipe-separated list for OR semantics
acceptedTopic
string
query
Sensitive topic that must be accepted (e.g. "Crypto", "Gambling"). Accepts a comma- or pipe-separated list for OR semantics
hyperlinksType
string
query
Hyperlinks type filter: "do-follow", "no-follow", or "sponsored-hyperlinks". Accepts a comma- or pipe-separated list for OR semantics
textCondition
string
query
Text condition filter: "changes-in-text-are-possible", "text-without-changes", "text-by-author", or "text-by-author-paid". Accepts a comma- or pipe-separated list for OR semantics
adLabel
string
query
Ad label filter: "with-adv-mark", "without-adv-mark", "adv-mark-may-be-added", or "without-ad-label-fee". Accepts a comma- or pipe-separated list for OR semantics
priceMin
integer
query
Minimum price in USD
priceMax
integer
query
Maximum price in USD
audienceMin
integer
query
Minimum audience
audienceMax
integer
query
Maximum audience
ahrefsDrMin
integer
query
Minimum Ahrefs DR
ahrefsDrMax
integer
query
Maximum Ahrefs DR
semrushTrafficMin
integer
query
Minimum Semrush organic traffic
semrushTrafficMax
integer
query
Maximum Semrush organic traffic
maiMin
integer
query
Minimum Medialister Attention Index (MAI)
maiMax
integer
query
Maximum Medialister Attention Index (MAI)
ratingMin
integer
query
Minimum rating
ratingMax
integer
query
Maximum rating
estimatedViewsMin
integer
query
Minimum estimated views
estimatedViewsMax
integer
query
Maximum estimated views
successRateMin
integer
query
Minimum Success Rate (0-100). Media with no resolved orders (null rate) are excluded when this filter is active
successRateMax
integer
query
Maximum Success Rate (0-100). Media with no resolved orders (null rate) are excluded when this filter is active
turnAroundTimeMax
integer
query
Maximum turnaround time in days
hyperlinksAmountMin
integer
query
Minimum number of hyperlinks allowed
homePageAnnounce
boolean
query
Only offers with homepage announcement placement
permanentPlacement
boolean
query
Only offers with permanent placement
pageIndex
boolean
query
Only offers with page indexing
uniqueText
boolean
query
Only offers requiring unique text
withVideo
boolean
query
Only offers with video support
sortBy
string
query
Sort field: "price", "name", "turnAroundTime", "createdAt", "updatedAt", "audience", "ahrefsDr", "semrushOrganicTraffic", "rating", "estimatedViews", "mai", "successRate". Media with no resolved orders (null Success Rate) sort last regardless of direction. Defaults to newest first ("createdAt" desc) when no full-text query is given
sortOrder
string
query
Sort order: "asc" or "desc" (default "asc")
perPage
integer
query
Results per page (default 10, max 100)

Response

application/ld+json200

Format collection

hydra:totalItems
integer
hydra:search
object
hydra:view
object
hydra:member
Format.jsonld-offer.read[]
required

{
  "hydra:totalItems": 0,
  "hydra:search": {
    "@type": "string",
    "hydra:template": "string",
    "hydra:variableRepresentation": "string",
    "hydra:mapping": [
      {
        "@type": "string",
        "variable": "string",
        "property": "string",
        "required": true
      }
    ]
  },
  "hydra:view": {
    "@id": "string",
    "@type": "string",
    "hydra:first": "string",
    "hydra:last": "string",
    "hydra:previous": "string",
    "hydra:next": "string"
  },
  "hydra:member": [
    {
      "@context": "string",
      "@id": "string",
      "@type": "string",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "formatType": "/api/format_types/b64ed0ca-1a05-4898-9a52-765fed38bc5c",
      "mediaProject": "/api/media_projects/b64ed0ca-1a05-4898-9a52-765fed38bc5c",
      "price": 100.1,
      "urlExamples": [
        "string"
      ],
      "seoMetric": {
        "@context": "string",
        "@id": "string",
        "@type": "string",
        "audience": 0,
        "audienceSourceDirect": 0,
        "audienceSourceReferrals": 0,
        "audienceSourceSearch": 0,
        "audienceSourceSocial": 0,
        "sourceDirect": 0,
        "sourceReferrals": 0,
        "sourceSearch": 0,
        "sourceSocial": 0,
        "sourceDisplay": 0,
        "sourceMail": 0,
        "ahrefsDr": 0,
        "semrushOrganicTraffic": 0,
        "semrushAuthorityScore": 0,
        "organicTrafficByAhrefs": 0,
        "estimatedViews": 0,
        "leadingCountries": {
          "key": "string"
        },
        "bounceRate": 0,
        "timeOnSite": 0,
        "pagePerVisit": 0,
        "mai": 0,
        "visits": {
          "string": "string"
        }
      }
    }
  ]
}

GET

/api/offers

curl -X GET "/api/offers" \
  -H "apikey: $MEDIALISTER_API_KEY"

{
  "hydra:totalItems": 0,
  "hydra:search": {
    "@type": "string",
    "hydra:template": "string",
    "hydra:variableRepresentation": "string",
    "hydra:mapping": [
      {
        "@type": "string",
        "variable": "string",
        "property": "string",
        "required": true
      }
    ]
  },
  "hydra:view": {
    "@id": "string",
    "@type": "string",
    "hydra:first": "string",
    "hydra:last": "string",
    "hydra:previous": "string",
    "hydra:next": "string"
  },
  "hydra:member": [
    {
      "@context": "string",
      "@id": "string",
      "@type": "string",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "formatType": "/api/format_types/b64ed0ca-1a05-4898-9a52-765fed38bc5c",
      "mediaProject": "/api/media_projects/b64ed0ca-1a05-4898-9a52-765fed38bc5c",
      "price": 100.1,
      "urlExamples": [
        "string"
      ],
      "seoMetric": {
        "@context": "string",
        "@id": "string",
        "@type": "string",
        "audience": 0,
        "audienceSourceDirect": 0,
        "audienceSourceReferrals": 0,
        "audienceSourceSearch": 0,
        "audienceSourceSocial": 0,
        "sourceDirect": 0,
        "sourceReferrals": 0,
        "sourceSearch": 0,
        "sourceSocial": 0,
        "sourceDisplay": 0,
        "sourceMail": 0,
        "ahrefsDr": 0,
        "semrushOrganicTraffic": 0,
        "semrushAuthorityScore": 0,
        "organicTrafficByAhrefs": 0,
        "estimatedViews": 0,
        "leadingCountries": {
          "key": "string"
        },
        "bounceRate": 0,
        "timeOnSite": 0,
        "pagePerVisit": 0,
        "mai": 0,
        "visits": {
          "string": "string"
        }
      }
    }
  ]
}