Link

Version: 1.0.0

Search

Content

In Cerkl terms, “Content” means Events, Stories, Needs, and Links added to your Cerkl instance by users or external RSS or Atom feeds. Content appears to your Subscribers in their personalized Newsletters, which present them with the types of Content (based on Categories) they’re most interested in.

Programmatically, each of these types of Content can be added, updated, and deleted using their own endpoints (e.g. POST a Story using /story, PUT, or DELETE a Story using /story/{id}). However, to GET Content, you must use the /content endpoint to retrieve all of the Content in a Cerkl and /content/{id} to retrieve a certain piece of Content specified by its Cerkl id.

For example, if you’ve authenticated with a Cerkl instance, you can get all of its content like this:

    $ curl --request GET https://api.cerkl.com/v3/content \
        --header 'Authorization: Bearer {ACCESS_TOKEN}'

Remember: all Cerkl GET endpoints that don’t target specific id values function as “GET all” requests. As with all of our other “GET all” functionality, you can specify page (defaults to 1) and page_size (defaults to 100) parameters to control the amount of information returned to you.

    $ curl --request GET https://api.cerkl.com/v3/content \
        --header 'Authorization: Bearer {ACCESS_TOKEN}' \
        -G -d page=1 -d page_size=100

Adding and Updating Content

As mentioned above, you will need to use the specific endpoints associated with each type of Content in order to perform create (POST), update (PUT), and delete (DELETE) operations. See the Events, Stories, and Needs pages for information on using those specific endpoints.

Content Insights

Because Cerkl gathers data about how Subscribers interact with Content, you can also query the Insights for a particular Content piece. For more information, see our Insights documentation.

Concepts