HHS Media Services API
Common Features / Behaviors * "sort" param: supports multi column sorting through the use of commas as delimiters, and a hyphen to denote descending order.…
Government & public#openapi#open-data
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Common Features / Behaviors * "sort" param: supports multi column sorting through the use of commas as delimiters, and a hyphen to denote descending order. Examples: name sort results by name ascending -name sort results by name descending -name,id sort results by name descending and then by id ascending id,-dateContentAuthored sort results by id ascending and then date descending Date formats: Date input format is expected to be based on RFC 3339 . Example: 2013-11-18T18:43:01Z
Endpoints 31
media
- GETGet MediaItems
/resources/media.json?max=0&offset=0&sort=string&order=string&mediaTypes=string&name=string&collectionId=0&nameContains=string&descriptionContains=string&sourceUrl=string&sourceUrlContains=string&customThumbnailUrl=string&customThumbnailUrlContains=string&dateContentAuthored=2024-01-01&dateContentUpdated=2024-01-01&dateContentPublished=2024-01-01&dateContentReviewed=2024-01-01&dateSyndicationCaptured=2024-01-01&dateSyndicationUpdated=2024-01-01&contentAuthoredSinceDate=2024-01-01&contentAuthoredBeforeDate=2024-01-01&contentAuthoredInRange=string&contentUpdatedSinceDate=2024-01-01&contentUpdatedBeforeDate=2024-01-01&contentUpdatedInRange=string&contentPublishedSinceDate=2024-01-01&contentPublishedBeforeDate=2024-01-01&contentPublishedInRange=string&contentReviewedSinceDate=2024-01-01&contentReviewedBeforeDate=2024-01-01&contentReviewedInRange=string&syndicationCapturedSinceDate=2024-01-01&syndicationCapturedBeforeDate=2024-01-01&syndicationCapturedInRange=string&syndicationUpdatedSinceDate=2024-01-01&syndicationUpdatedBeforeDate=2024-01-01&syndicationUpdatedInRange=string&syndicationVisibleSinceDate=2024-01-01&syndicationVisibleBeforeDate=2024-01-01&syndicationVisibleInRange=2024-01-01&languageId=0&languageName=string&languageIsoCode=string&hash=string&hashContains=string&sourceId=0&sourceName=string&sourceNameContains=string&sourceAcronym=string&sourceAcronymContains=string&tagIds=string&restrictToSet=string&createdBy=stringMedia Items Listings - GETGet the list of featured content in the syndication system
/resources/media/featured.json?sort=string&max=0&offset=0Get the list of featured content in the syndication system - GETGet MediaItems by popularity
/resources/media/mostPopularMedia.:format?max=0&offset=0Get the media with the highest ratings. - GETGet MediaItems by search query
/resources/media/searchResults.json?q=string&max=0&offset=0Full search - GETGet MediaItem by ID
/resources/media/:id.jsonInformation about a specific media item - GETGet content for MediaItem
/resources/media/:id/content?calledByBuild=trueThe actual media content (html, image, etc...) - GETGet embed code for MediaItem
/resources/media/:id/embed.json?flavor=string&width=0&height=0&iframeName=string&excludeJquery=false&excludeDiv=false&divId=string&displayMethod=stringGet the javascript or iframe embed code for this item (to embed it on a web page). - GETGet Tag by ID
/resources/media/:id/preview.jpgGet the jpg preview of the content item where applicable. - GETGet related MediaItems by ID
/resources/media/:id/relatedMedia.:format?max=0&offset=0&sort=stringGet the media related to the current media item. - GETGet syndicated content for MediaItem
/resources/media/:id/syndicate.:format?cssClass=syndicate&stripStyles=false&stripScripts=false&stripImages=false&stripBreaks=false&stripClasses=false&font-size=0&imageFloat=string&imageMargin=string&autoplay=true&rel=falseGet syndicated content. - GETGet JPG thumbnail for MediaItem
/resources/media/:id/thumbnail.jpgGet the jpg thumbnail of the content item where applicable. - GETGet Youtube metadata for MediaItem
/resources/media/:id/youtubeMetaData.jsonYoutube meta-data for a video item.
languages
- GETGet Languages
/resources/languages.json?max=0&offset=0&sort=stringLanguage Listings - GETGet Language by ID
/resources/languages/:id.jsonInformation about a specific language
mediaTypes
- GETGet MediaTypes
/resources/mediaTypes.:formatInformation about media types
tags
- GETGet Tags
/resources/tags.:format?sort=string&max=0&offset=0&name=string&nameContains=string&mediaId=0&typeId=0&typeName=stringList of Tags - GETGet TagLanguages
/resources/tags/tagLanguages.:formatList of Tag Languages - GETGet MediaItems for Tag
/resources/tags/tagTypes.:formatList of Types - GETGet Tag by ID
/resources/tags/:id.:formatInformation about a specific tag - GETGet MediaItems for Tag
/resources/tags/:id/media.:format?sort=string&max=0&offset=0MediaItem - GETGet related Tags by ID
/resources/tags/:id/related.:format?sort=string&max=0&offset=0Information about related tags to a specific tag - GETGet MediaItems for Tag
/resources/tags/:id/syndicate.:format?displayMethod=stringMediaItem
campaigns
- GETGet Campaigns
/resources/campaigns.json?max=0&offset=0&sort=stringMedia Listings for a specific campaign - GETGet Campaign by ID
/resources/campaigns/:id.jsonInformation about a specific campaign - GETGet MediaItems by Campaign ID
/resources/campaigns/:id/media.json?sort=string&max=0&offset=0Campaign Listings - GETGet MediaItems for Campaign
/resources/campaigns/:id/syndicate.:format?displayMethod=stringMediaItem
sources
- GETGet Sources
/resources/sources.json?max=0&offset=0&sort=stringSource Listings - GETGet Source by ID
/resources/sources/:id.jsonInformation about a specific source. - GETGet MediaItems for Source
/resources/sources/:id/syndicate.:format?displayMethod=stringMediaItem
resources
- GETGet Resources by search query
/resources.json?q=stringGlobal search
userMediaLists
- GETGet UserMediaList by ID
/resources/userMediaLists/:id.json?displayMethod=stringGet a specific user media list.
API details
- Authentication
- None declared in the description
- Operations
- 31 operations on 31 pathsGET 31
- Main resources
- media 12tags 7campaigns 4sources 3languages 2mediaTypes 1resources 1userMediaLists 1
- Response formats
application/json- Description format
- OpenAPI 3.0.0, API version
2 - Links
- OpenAPI document · Terms of service
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the HHS Media Services API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the HHS Media Services API collection, without the publisher's secrets.
- Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
- Send a requestPick an endpoint, for example “Get MediaItems” (GET /resources/media.json?max=0&offset=0&sort=string&order=string&mediaTypes=string&name=string&collectionId=0&nameContains=string&descriptionContains=string&sourceUrl=string&sourceUrlContains=string&customThumbnailUrl=string&customThumbnailUrlContains=string&dateContentAuthored=2024-01-01&dateContentUpdated=2024-01-01&dateContentPublished=2024-01-01&dateContentReviewed=2024-01-01&dateSyndicationCaptured=2024-01-01&dateSyndicationUpdated=2024-01-01&contentAuthoredSinceDate=2024-01-01&contentAuthoredBeforeDate=2024-01-01&contentAuthoredInRange=string&contentUpdatedSinceDate=2024-01-01&contentUpdatedBeforeDate=2024-01-01&contentUpdatedInRange=string&contentPublishedSinceDate=2024-01-01&contentPublishedBeforeDate=2024-01-01&contentPublishedInRange=string&contentReviewedSinceDate=2024-01-01&contentReviewedBeforeDate=2024-01-01&contentReviewedInRange=string&syndicationCapturedSinceDate=2024-01-01&syndicationCapturedBeforeDate=2024-01-01&syndicationCapturedInRange=string&syndicationUpdatedSinceDate=2024-01-01&syndicationUpdatedBeforeDate=2024-01-01&syndicationUpdatedInRange=string&syndicationVisibleSinceDate=2024-01-01&syndicationVisibleBeforeDate=2024-01-01&syndicationVisibleInRange=2024-01-01&languageId=0&languageName=string&languageIsoCode=string&hash=string&hashContains=string&sourceId=0&sourceName=string&sourceNameContains=string&sourceAcronym=string&sourceAcronymContains=string&tagIds=string&restrictToSet=string&createdBy=string), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the HHS Media Services API?
Common Features / Behaviors * "sort" param: supports multi column sorting through the use of commas as delimiters, and a hyphen to denote descending order.… It is listed under Government & public and has 31 endpoints.
Who publishes the HHS Media Services API?
It is listed from Hhs's public API description (an OpenAPI document), not published by Hhs on Swastik Codes. Anyone who controls hhs.gov can claim the profile by adding a DNS TXT record.
How do I authenticate with the HHS Media Services API?
Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.
How many endpoints does the HHS Media Services API have?
31 operations on 31 paths (31 GET). The largest groups are media, tags, campaigns, sources.
Is forking the HHS Media Services API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.