Skip to main content

mediaChannelCoverage

Reports how the listings on a channel meet its image requirements, worst first.

Business Rules​

  • Only active images in the required slots count.
  • Known dimensions and content types must meet the channel requirements. An image with unknown dimensions or an unknown content type is not disqualified.
  • Listings missing the most slots lead, ready listings trail, and SKU breaks ties.
  • listingCount and completeCount describe the whole channel. matchedCount and listings apply the filters.
  • Returns 25 listings per page by default, and at most 100.

Error Scenarios​

  • The channel does not exist or belongs to another company: Sales channel not found.

Permissions Required​

  • get_images
mediaChannelCoverage(
  filters: MediaChannelCoverageFilterInput
  limit: Int = 25
  offset: Int = 0
  salesChannelId: ID!
): MediaChannelCoverage!

Arguments​

mediaChannelCoverage.filters ● MediaChannelCoverageFilterInput input products​

Search and readiness filters for the listing page.

mediaChannelCoverage.limit ● Int scalar common​

How many listings to return, up to 100. Defaults to 25.

mediaChannelCoverage.offset ● Int scalar common​

How many listings to skip.

mediaChannelCoverage.salesChannelId ● ID! non-null scalar common​

The channel to read.

Type​

MediaChannelCoverage object products​

A channel's image coverage: how many listings meet its requirements, and where each one stands.