NewsEdge API

Saving and Reusing Searches

Searches can get quite complex so being able to save searches helps you organize, test, and, reuse complex queries. You can then combine saved searches with other search queries to execute at runtime.

Saving a Search
Running Saved Searches
Combining Saved Searches
Controlling Dates of a Saved Search

Saving a Search

This example saves a search based on industry and subject metadata that we will then combine with other search queries. This is a pharmaceutical example using the following metadata:

ii/hcare.pharma - An industry code representing Pharmaceuticals obtained by using industry/search with query=(pharmaceuticals).
is/haw.clinical - A subject code representing Clinical Trial Events obtained by using subject/search with query=("clinical trials").
is/haw.drugappr - A subject code representing FDA Drug Approval obtained by using subject/search with query=(FDA).

Create a saved search.

To create a saved search, use savedsearch/create with the required parameters name and query. This example uses the industry and subject codes listed above.

Note in the returned results the search attribute of the savedsearch element from savedsearch/create. The query includes the search parameters summary, sortBy, dedup, and cluster. These are the default values for these parameters.

Request

https://secure.newsedge.com/opensapi/20/savedsearch/create?session=935DA0B364E9E130F0EC3827FC3CCC9C&name=Drug Trials&query=([INDC:ii/hcare.pharma]%20and%20[SUBC:is/haw.clinical]%20and%20[SUBC:is/haw.drugappr])

Response

<opens-api>
  <status>OK</status>
  <savedsearch ss="13819" name="Drug Trials" permission="WRITE" search="(([INDC:ii/hcare.pharma] and [SUBC:is/haw.clinical] and [SUBC:is/haw.drugappr]))&summary=1&sortBy=receivedate&dedup=1&cluster=1"/>
</opens-api>

List saved searches and get saved search IDs.

To identify a saved search in other API requests, use the ss attribute of the savedsearch element from savedsearch/list.

Request

https://secure.newsedge.com/opensapi/20/savedsearch/list?session=935DA0B364E9E130F0EC3827FC3CCC9C

Response

<opens-api>
  <status>OK</status>
    <savedsearches>
    <savedsearch ss="13819" owner="API User" level="PERSONAL" name="Drug Trials" permission="WRITE"/>
    . . .
  </savedsearches>
</opens-api>

Get information about a saved search.

Use savedsearch/info with the session and search parameters to view information about a saved search including the search query. This example uses the saved search identified in the previous step as 13819.

Request

https://secure.newsedge.com/opensapi/20/savedsearch/info?session=935DA0B364E9E130F0EC3827FC3CCC9C&search=13819

Response

<opens-api>
  <status>OK</status>
  <savedsearch ss="13819" owner="API User" level="PERSONAL" name="Drug Trials" permission="WRITE" search="(([INDC:ii/hcare.pharma] and [SUBC:is/haw.clinical] and [SUBC:is/haw.drugappr]))&summary=1&sortBy=receivedate&dedup=1&cluster=1" createdBy="API User" modifiedBy="" modifiedOn="20160314T185511-0400" cp_time="" cp_active=""/>
</opens-api>

Testing saved searches.

Use news/search to run a saved search. Include the savedSearch parameter of news/search. The returned results include all of the saved search settings in the search element from news/search.

Request

https://secure.newsedge.com/opensapi/20/news/search?session=935DA0B364E9E130F0EC3827FC3CCC9C&savedSearch=13819

Response

<searchResults searchKey="112130_20160314T192641446">
  <search startDate="20160213T230000-0500" endDate="20160314T192741-0400" resultsPerPage="20" stem="1" summary="1" metadata="0" taxonomy="0" entity="0" provider-code="0" minimum="0" cluster="1" dedup="1" refine="0" sorting="receiveDate" score="0" highlight="false" relevanceCutOff="85" busRelCutOff="70" includeProvDup="0" includeNRC="" filterLicensedPkg="" filterWebLinkedPkg="">
    <queryString>
    (([INDC:ii/hcare.pharma] and [SUBC:is/haw.clinical] and [SUBC:is/haw.drugappr]))
    </queryString>
  </search>
  <highlightTerms...>...</highlightTerms>
  <pageInfo>
    <totalResults partialTotal="true">56</totalResults>
    <totalPages partialTotal="true">3</totalPages>
    <resultsPage>1</resultsPage>
    <numberResults>20</numberResults>
    <topResult>1</topResult>
    <bottomResult>20</bottomResult>
  </pageInfo>
  <results status="true">
    <result score="0.45881796">...</result>
    <result score="0.37921882">...</result>
    <result score="0.8091813">...</result>
    <result score="0.12573923">...</result>
    <result score="0.56557167">...</result>
    <result score="0.26610693">...</result>
    <result score="0.6466494">...</result>
    <result score="0.5437965">...</result>
    <result score="0.35924968">...</result>
    <result score="0.18163575">...</result>
    <result score="0.16668049">...</result>
    <result score="0.11905816">...</result>
    <result score="0.22982676">...</result>
    <result score="0.2604405">...</result>
    <result score="0.119303785">...</result>
    <result score="0.11744319">...</result>
    <result score="0.27251387">...</result>
    <result score="0.26059818">...</result>
    <result score="0.36251917">...</result>
    <result score="0.13112316">...</result>
  </results>
</searchResults>

Modifying a saved search.

Use savedsearch/update to make changes to a saved search. This example modifies the search using the filterWebLinkedPkg parameter of savedsearch/update.

Request

https://secure.newsedge.com/opensapi/20/savedsearch/update?session=935DA0B364E9E130F0EC3827FC3CCC9C&search=13819&query=([INDC:ii/hcare.pharma] and [SUBC:is/haw.clinical] and [SUBC:is/haw.drugappr])&summary=1&sort=receivedate&dedup=1&cluster=1&filterWebLinkedPkg=WL-Esssential

Response

<opens-api>
  <status>OK</status>
</opens-api>

Deleting a saved search using savedsearch/delete.

Request

https://secure.newsedge.com/opensapi/20/savedsearch/delete?session=935DA0B364E9E130F0EC3827FC3CCC9C&search=13819

Response

<opens-api>
  <status>OK</status>
</opens-api>

Running Saved Searches

In the previous example, we created a saved search to store a common query we expect to use in many searches. In this example we use news/search to execute the saved search. We also show how to combine a saved search with other queries.

Running a saved search.

Use news/search with the savedSearch parameter to execute a saved search. This example shows the details of one of the results.

Request

https://secure.newsedge.com/opensapi/20/news/search?session=935DA0B364E9E130F0EC3827FC3CCC9C&savedSearch=13819

Response

<searchResults searchKey="112130_20160318T163017422">
  <search startDate="20160217T230000-0500" endDate="20160318T163117-0400" resultsPerPage="20" stem="1" summary="1" metadata="0" taxonomy="0" entity="0" provider-code="0" minimum="0" cluster="1" dedup="1" refine="0" sorting="receiveDate" score="0" highlight="false" relevanceCutOff="85" busRelCutOff="70" includeProvDup="0" includeNRC="" filterLicensedPkg="" filterWebLinkedPkg="WL-Essential">
    <queryString>...</queryString>
  </search>
  <highlightTerms str="indCodeHighlight=ii%2Fhcare.pharma&subCodeHighlight=is%2Fhaw.clinical,is%2Fhaw.drugappr">...</highlightTerms>
  <pageInfo>...</pageInfo>
  <results status="true">
    <result score="0.16247931">...</result>
    <result score="0.32533845">
      <id>...</id>
      <storyURL>
        https://secure.newsedge.com/opensapi/20/news/read?key=_7WbeLYfeqj0UcD9KnCGj1S95flFLbVH04mujRfUbKz44vhulqaZ6u4gcUprpXRnN4vKHKUGRYAo_c231kyIPTIM0_ZIQ3BQhyH8bvg6Qr2gFvPtKRf6UasrvOIyMqEJ
      </storyURL>
      <type code="News"/>
      <publication-date>20160315T090000-0400</publication-date>
      <received-date>20160315T090000-0400</received-date>
      <lastchanged-date>20160315T090000-0400</received-date>
      <source code="Business_Wire" name="Business Wire" short-name="Business Wire">
        <provider code="BIZWIRE_" name="Business Wire, Inc.">
          <service code="Business_Wire" name="Press Releases - English"/>
        </provider>
        <topness code="TRUE"/>
        <content-type code="PR" name="Press Release"/>
        <media-type code="Text" name="Text"/>
        <rights code="CLEARED" name="Licensed Feed"/>
        <geo-origin>
          <entity name="North America">
            <property source="xmltag.org" code="loc">RB/nam</property>
            <property code="fullname">North America</property>
          </entity>
          <entity name="United States">
            <property source="xmltag.org" code="loc">RC/US</property>
            <property code="fullname">United States</property>
          </entity>
          <entity name="Americas">
            <property source="xmltag.org" code="loc">RR/am</property>
            <property code="fullname">Americas</property>
          </entity>
          <entity name="New York">
            <property source="xmltag.org" code="loc">RS/US.NY</property>
            <property code="fullname">New York</property>
          </entity>
          <entity name="New York City">
            <property source="xmltag.org" code="loc">RU/us.ny.nyc</property>
            <property code="fullname">New York City, New York</property>
          </entity>
        </geo-origin>
        <geo-focus>
          <entity name="United States">
            <property source="xmltag.org" code="loc">GC/US</property>
            <property code="fullname">United States</property>
          </entity>
        </geo-focus>
        <classification>
          <taxonomies>
            <taxonomy code="Subject">
              <classifier name="Business and Commerce" code="PX/biz"></classifier>
            </taxonomy>
          </taxonomies>
        </classification>
      </source>
      <packages>
        <package code="OCS"/>
        <package code="NewsEdge"/>
        <package code="CCS"/>
      </packages>
      <references></references>
      <business-relevance>90</business-relevance>
      <dup>0</dup>
      <wordcount>437</wordcount>
      <headline>
Ligand Partner Spectrum Pharmaceuticals Receives FDA Approval of EVOMELA™ (melphalan) for Injection
</headline>
      <copyrightline>Copyright Business Wire 2016</copyrightline>
      <language code="en"/>
      <cluster cluster-publication-date="20160315T090000-0400" cluster-received-date="20160315T090000-0400">
        <cluster-result score="0.25943053">
          <id>...</id>
          <storyURL>
            https://secure.newsedge.com/opensapi/20/news/read?key=Ul0_DCvowdTeRmTmZKuV2zD6IYFjWa3FoX4rhca8QseEkBZVvHVvAZqo4EnJUujJBubIvj2KVfZMITb0pVqHqQg4SFnHZYH6Lnv2CtUbFGJG68-EC4qcvhnfCfdw97mC
          </storyURL>
          <type code="News"/>
          <publication-date>20160315T070000-0400</publication-date>
          <received-date>20160315T070000-0400</received-date>
          <source code="Business_Wire" name="Business Wire" short-name="Business Wire">
            <provider code="BIZWIRE_" name="Business Wire, Inc.">
              <service code="Business_Wire" name="Press Releases - English"/>
            </provider>
            <topness code="TRUE"/>
            <content-type code="PR" name="Press Release"/>
            <media-type code="Text" name="Text"/>
            <rights code="CLEARED" name="Licensed Feed"/>
            <geo-origin>
              <entity name="North America">
                <property source="xmltag.org" code="loc">RB/nam</property>
                <property code="fullname">North America</property>
              </entity>
              <entity name="United States">
                <property source="xmltag.org" code="loc">RC/US</property>
                <property code="fullname">United States</property>
              </entity>
              <entity name="Americas">
                <property source="xmltag.org" code="loc">RR/am</property>
                <property code="fullname">Americas</property>
              </entity>
              <entity name="New York">
                <property source="xmltag.org" code="loc">RS/US.NY</property>
                <property code="fullname">New York</property>
              </entity>
              <entity name="New York City">
                <property source="xmltag.org" code="loc">RU/us.ny.nyc</property>
                <property code="fullname">New York City, New York</property>
              </entity>
            </geo-origin>
            <geo-focus>
              <entity name="United States">
                <property source="xmltag.org" code="loc">GC/US</property>
                <property code="fullname">United States</property>
              </entity>
            </geo-focus>
            <classification>
              <taxonomies>
                <taxonomy code="Subject">
                  <classifier name="Business and Commerce" code="PX/biz"></classifier>
                </taxonomy>
              </taxonomies>
            </classification>
          </source>
          <packages>
            <package code="OCS"/>
            <package code="NewsEdge"/>
            <package code="CCS"/>
          </packages>
          <references></references>
          <business-relevance>90</business-relevance>
          <dup>0</dup>
          <wordcount>439</wordcount>
          <headline>
            FDA Grants Spectrum Pharmaceuticals Approval of EVOMELA™ (melphalan) for Injection
          </headline>
          <copyrightline>Copyright Business Wire 2016</copyrightline>
          <language code="en"/>
          <summary>
EVOMELA Received FDA Approval for Two Indications: High-Dose Conditioning Treatment for Multiple Myeloma (MM) Patients Undergoing Autologous Stem Cell Transplantation (ASCT) Palliative Treatment of Patients with MM Who Cannot Take Oral Therapy EVOMELA Admixture Solution is Stable for 4 Hours at Room Temperature in Addition to the 1 Hour Following Reconstitution EVOMELA Does Not Contain ...
</summary>
        </cluster-result>
      </cluster>
      <summary>
        Ligand to receive $6 million milestone related to EVOMELA’s approval SAN DIEGO--(BUSINESS WIRE)-- Ligand Pharmaceuticals Incorporated (NASDAQ: LGND) announces that Spectrum Pharmaceuticals, Inc. (NASDAQ: SPPI), a biotechnology company with fully integrated commercial and drug development operations with a primary focus in hematology and oncology, received approval from the U.S. Food and Drug ...
      </summary>
    </result>
    <result score="0.1571539">...</result>
    <result score="0.3810533">...</result>
    <result score="0.43835115">...</result>
    <result score="0.36356583">...</result>
    <result score="0.8008448">...</result>
    <result score="0.120111965">...</result>
    <result score="0.563019">...</result>
    <result score="0.25803387">...</result>
    <result score="0.6424432">...</result>
    <result score="0.537213">...</result>
    <result score="0.35691288">...</result>
    <result score="0.18083055">...</result>
    <result score="0.16556929">...</result>
    <result score="0.118735865">...</result>
    <result score="0.22836345">...</result>
    <result score="0.25943053">...</result>
    <result score="0.1188115">...</result>
    <result score="0.117083944">...</result>
  </results>

Adding a query to a saved search.

Use the news/search addlQuery parameter in combination with the savedSearch parameter to combine two queries. The addlQuery is appended to the saved search as an "and" clause.

In this example, we use our drug trials saved search and add a query to narrow the results to a specific pharmaceutical company. The additional query contains the ACORN value, a unique company metadata code representing the pharmaceutical company, Pfizer. This number was obtained by using company/search with the parameter query=(Pfizer).

Notice the queryString element from news/search contains the search query terms from the saved search and the company ACORN. Also, the totalResults element under the pageInfo element is now 8, representing stories related only to Pfizer.

Request

https://secure.newsedge.com/opensapi/20/news/search?session=935DA0B364E9E130F0EC3827FC3CCC9C&savedSearch=13819&addlQuery=([COM:/acorn=4101678755])

Response

<searchResults searchKey="112130_20160318T165336926">
  <search startDate="20160217T230000-0500" endDate="20160318T165436-0400" resultsPerPage="20" stem="1" summary="1" metadata="0" taxonomy="0" entity="0" provider-code="0" minimum="0" cluster="1" dedup="1" refine="0" sorting="receiveDate" score="0" highlight="false" relevanceCutOff="85" busRelCutOff="70" includeProvDup="0" includeNRC="" filterLicensedPkg="" filterWebLinkedPkg="">
    <queryString>
    ((([INDC:ii/hcare.pharma] and [SUBC:is/haw.clinical] and [SUBC:is/haw.drugappr])) and (([COM:/acorn=4101678755])))
    </queryString>
  </search>
  <highlightTerms str="comHighlight=%2Facorn%3D4101678755&indCodeHighlight=ii%2Fhcare.pharma&subCodeHighlight=is%2Fhaw.clinical,is%2Fhaw.drugappr">...</highlightTerms>
  <pageInfo>
    <totalResults>8</totalResults>
    <totalPages>1</totalPages>
    <resultsPage>1</resultsPage>
    <numberResults>8</numberResults>
    <topResult>1</topResult>
    <bottomResult>8</bottomResult>
  </pageInfo>
  <results status="true">
    <result score="0.15353832">...</result>
    <result score="0.55066735">...</result>
    <result score="0.19070654">...</result>
    <result score="1.0">...</result>
    <result score="0.9514456">...</result>
    <result score="0.6430321">...</result>
    <result score="0.7364404">...</result>
    <result score="1.0">...</result>
  </results>
</searchResults>

Including saved searches within a news/search query.

Use the format [ss:ss-ID] in the query parameter of news/search to include a saved search within the query itself. This example shows another way to execute our drug trials saved search combined with the specific pharmaceutical ACORN code for the company Pfizer.

Note the results produced are equivalent to the results of the previous step, except for the different form of the queryString element from news/search.

Request

https://secure.newsedge.com/opensapi/20/news/search?session=935DA0B364E9E130F0EC3827FC3CCC9C&query=([ss:13819] and [COM:/acorn=4101678755])

Response

<searchResults searchKey="112130_20160318T165336926">
  <search startDate="20160217T230000-0500" endDate="20160318T165436-0400" resultsPerPage="20" stem="1" summary="1" metadata="0" taxonomy="0" entity="0" provider-code="0" minimum="0" cluster="1" dedup="1" refine="0" sorting="receiveDate" score="0" highlight="false" relevanceCutOff="85" busRelCutOff="70" includeProvDup="0" includeNRC="" filterLicensedPkg="" filterWebLinkedPkg="">
    <queryString>(([ss:13819] AND [COM:/acorn=4101678755]))</queryString>
  </search>
  <highlightTerms str="comHighlight=%2Facorn%3D4101678755&indCodeHighlight=ii%2Fhcare.pharma&subCodeHighlight=is%2Fhaw.clinical,is%2Fhaw.drugappr">...</highlightTerms>
  <pageInfo>
    <totalResults>8</totalResults>
    <totalPages>1</totalPages>
    <resultsPage>1</resultsPage>
    <numberResults>8</numberResults>
    <topResult>1</topResult>
    <bottomResult>8</bottomResult>
  </pageInfo>
  <results status="true">
    <result score="0.15353832">...</result>
    <result score="0.55066735">...</result>
    <result score="0.19070654">...</result>
    <result score="1.0">...</result>
    <result score="0.9514456">...</result>
    <result score="0.6430321">...</result>
    <result score="0.7364404">...</result>
    <result score="1.0">...</result>
  </results>
</searchResults>

Combining Saved Searches

Saved searches provide a powerful tool for combining and executing complex queries. This example shows how to combine saved searches that both include queries and exclude other queries to obtain good news search results.

Create another saved search.
This saved search uses the following subject code metadata that we will combine with other queries in a later step:
- is/appsci.patentap - A subject code representing Patent Applications obtained by using subject/search with the parameter query=(patent).
- is/fin.markets - A subject code representing Market News and Updates obtained by using subject/search with the parameter query=("market news").
Request
```
https://secure.newsedge.com/opensapi/20/savedsearch/create?session=935DA0B364E9E130F0EC3827FC3CCC9C&name=Patent and Market News&query=([SUBC:is/appsci.patentap] and [SUBC:is/fin.markets])
```
Response
```
<opens-api>
  <status>OK</status>
  <savedsearch ss="13821" name="Patent and Market News" permission="WRITE" search="(([SUBC:is/appsci.patentap] and [SUBC:is/fin.markets]))&summary=1&sortBy=receivedate&dedup=1&cluster=1"/>
</opens-api>
```

Get the saved search IDs.

Obtain the saved search IDs from the ss attribute of the savedSearch element from savedsearch/info.

Request

https://secure.newsedge.com/opensapi/20/savedsearch/list?session=935DA0B364E9E130F0EC3827FC3CCC9C

Response

<opens-api>
  <status>OK</status>
  <savedsearches>
    <savedsearch ss="13819" owner="API User" level="PERSONAL" name="Drug Trials" permission="WRITE"/>
    <savedsearch ss="13821" owner="API User" level="PERSONAL" name="Patent and Market News" permission="WRITE"/>
    . . .
  </savedsearches>
</opens-api>

Combine saved searches.

This example creates a query that combines the saved searches with other query information as follows:

[COM:/acorn=4101678755] - A specific company (Pfizer) based on the company ACORN code.
AND [ss:13819] - The Drug Trials saved search.
NOT [ss:13821] - Exclude news stories that match the Patent and Market News saved search.

Finally, since searches are for the current day by default, the example includes the searchDate parameter of news/search set to past7days to retrieve results for the past week.

Request

https://secure.newsedge.com/opensapi/20/news/search?session=935DA0B364E9E130F0EC3827FC3CCC9C&query=([COM:/acorn=4101678755] AND [ss:13819] NOT [ss:13821])&searchDate=past7days

Response

<searchResults searchKey="112030_20160319T113107066">
  <search startDate="20160311T230000-0500" endDate="20160319T113207-0400" resultsPerPage="20" stem="1" summary="0" metadata="0" taxonomy="0" entity="0" provider-code="0" minimum="0" cluster="1" dedup="1" refine="0" sorting="receiveDate" score="0" highlight="false" relevanceCutOff="85" busRelCutOff="70" includeProvDup="0" includeNRC="" filterLicensedPkg="" filterWebLinkedPkg="">
    <queryString>
    (([COM:/acorn=4101678755] AND [ss:13819] NOT [ss:13821]))
    </queryString>
  </search>
  <highlightTerms . . .>...</highlightTerms>
  <pageInfo>...</pageInfo>
  <results status="true">...</results>
</searchResults>

Nested saved searches.

We can save the search from the previous step that contains other saved searches to run as a weekly review of Pfizer Drug Trial news.

Request

https://secure.newsedge.com/opensapi/20/savedsearch/create?session=935DA0B364E9E130F0EC3827FC3CCC9C&name=Weekly Pfizer Report&query=([COM:/acorn=4101678755] AND [ss:13819] NOT [ss:13821])&searchDate=past7days

Response

<opens-api>
  <status>OK</status>
  <savedsearch ss="13822" name="Weekly Pfizer Report" permission="WRITE" search="(([COM:/acorn=4101678755] AND [ss:13819] NOT [ss:13821]))&summary=1&sortBy=receivedate&dedup=1&cluster=1&searchDate=past7days"/>
</opens-api>

Controlling Dates of a Saved Search

In the previous example we created a saved search that returns a week of news stories about a pharmaceutical company's clinical trials. Suppose you want to run this search daily, and you only want to see stories back to the last time you ran the search, not a full week. The following steps show how to use the saved search checkpoint mode to control search dates without modifying the fixed date settings of a saved search. The steps are divided into the following phases:

Initializing checkpoint mode
Using checkpoint mode
Deactivating checkpoint mode

Initializing Checkpoint Mode
Using Checkpoint Mode.
Deactivating Checkpoint Mode

Initializing Checkpoint Mode

Back to Example

Find the saved search ID.

Use savedsearch/list to get an existing saved search ID.

Request

https://secure.newsedge.com/opensapi/20/savedsearch/list?session=935DA0B364E9E130F0EC3827FC3CCC9C

Response

<opens-api>
  <status>OK</status>
  <savedsearches>
    <savedsearch ss="13819" owner="API User" level="PERSONAL" name="Drug Trials" permission="WRITE"/>
    <savedsearch ss="13821" owner="API User" level="PERSONAL" name="Patent and Market News" permission="WRITE"/>
    <savedsearch ss="13822" owner="API User" level="PERSONAL" name="Weekly Pfizer Report" permission="WRITE"/>
    . . .
  </savedsearches>
</opens-api>

Run the saved search.

Use news/search with savedSearch parameter.

Note in the results of this search, the dates are between the current time and seven days ago.

Request

https://secure.newsedge.com/opensapi/20/news/search?session=935DA0B364E9E130F0EC3827FC3CCC9C&savedSearch=13822

Response

<searchResults searchKey="112030_20160518T104025423">
  <search startDate="20160511T000000-0400" endDate="20160518T104125-0400" resultsPerPage="20" stem="1" summary="1" metadata="0" taxonomy="0" entity="0" provider-code="0" minimum="0" cluster="1" dedup="1" refine="0" sorting="receiveDate" score="0" highlight="false" relevanceCutOff="85" busRelCutOff="70" includeProvDup="0" includeNRC="" filterLicensedPkg="" filterWebLinkedPkg="">
    <queryString>
    (([COM:/acorn=4101678755] AND [ss:13819] NOT [ss:13821]))
    </queryString>
  </search>
  <highlightTerms str="comHighlight=%2Facorn%3D4101678755&indCodeHighlight=ii%2Fhcare.pharma&subCodeHighlight=is%2Fhaw.clinical,is%2Fhaw.drugappr">
    <highlight/>
    <comCodeHighlight/>
    <comHighlight>/acorn=4101678755</comHighlight>
    <peoCodeHighlight/>
    <geoCodeHighlight/>
    <indCodeHighlight>ii/hcare.pharma</indCodeHighlight>
    <subCodeHighlight>is/haw.clinical,is/haw.drugappr</subCodeHighlight>
  </highlightTerms>
  <pageInfo>
  <totalResults>8</totalResults>
    <totalPages>1</totalPages>
    <resultsPage>1</resultsPage>
    <numberResults>8</numberResults>
    <topResult>1</topResult>
    <bottomResult>8</bottomResult>
  </pageInfo>
  <results status="true"/>
    <result score="0.17765328">
      <id>
        50MoIT2HHYWsezJocqp6dbB64wErz3zb88bylYJDJOdeiMh0hEzJB197g33AYS2Kg5gl-B9_Ds5CXGvy3owVEA**
      </id>
      <storyURL>
        https://secure.newsedge.com/opensapi/20/news/read?key=lYVORgB4VEexpnh9Y-B3LdpNN20pXToUNsnJcjp5RxuIiEk7pLgDB2HXKviW11f4xPpA6SC6hYmJKzzQoA5-AqE40pGgE5BUNhnW591piBJrCxf5h-UTXPHsgD8LJ2Y5N5GQnRt0Lxv8boo4FDJtQQ**
      </storyURL>
      <type code="News"/>
      <publication-date>20160418T111500-0400</publication-date>
      <received-date>20160418T111500-0400</received-date>
      <lastchanged-date>20160418T111500-0400</publication-date>
      <source code="ENP_Newswire" name="ENP Newswire" short-name="ENP Newswire">
        <provider code="M2______" name="M2 Communications Ltd">
          <service code="M2_ENP_Newswire" name="ENP Newswire"/>
        </provider>
        <topness code="FALSE"/>
        <content-type code="PR" name="Press Release"/>
        <media-type code="Text" name="Text"/>
        <rights code="CLEARED" name="Licensed Feed"/>
        <geo-origin>
          <entity name="Northern Europe">
            <property source="xmltag.org" code="loc">RB/neur</property>
            <property code="fullname">Northern Europe</property>
          </entity>
          <entity name="United Kingdom">
            <property source="xmltag.org" code="loc">RC/GB</property>
            <property code="fullname">United Kingdom</property>
          </entity>
          <entity name="Europe">
            <property source="xmltag.org" code="loc">RR/eur</property>
            <property code="fullname">Europe</property>
          </entity>
          <entity name="England">
            <property source="xmltag.org" code="loc">RS/GB.ENG</property>
            <property code="fullname">England, United Kingdom</property>
          </entity>
          <entity name="London">
            <property source="xmltag.org" code="loc">RU/gb.eng.london</property>
            <property code="fullname">London, England, United Kingdom</property>
          </entity>
        </geo-origin>
        <geo-focus>
          <entity name="Global">
            <property source="xmltag.org" code="loc">GR/glb</property>
            <property code="fullname">Global</property>
          </entity>
        </geo-focus>
        <classification>
          <taxonomies>
            <taxonomy code="Industry">
              <classifier name="Information and Media" code="PI/infomed"></classifier>
            </taxonomy>
          </taxonomies>
        </classification>
      </source>
      <packages>
        <package code="OCS"/>
        <package code="NewsEdge"/>
        <package code="CCS"/>
      </packages>
      <references></references>
      <business-relevance>70</business-relevance>
      <dup>0</dup>
      <wordcount>1396</wordcount>
      <headline>
        Abbott Wins FDA Approval for First Companion Diagnostic in Leukemia
      </headline>
      <copyrightline>(c) 2016 Electronic News Publishing -</copyrightline>
      <language code="en"/>
      <summary>
        Release date- 15042016 - In a first for the disease, there is now an FDA-approved companion diagnostic and drug pairing intended to treat a specific population of leukemia patients. Some patients with a common type of adult leukemia, B-cell chronic lymphocytic leukemia (CLL), have a deletion of the TP53 gene, also known as the 17p deletion. This deletion is linked to a lower response rate to ...
      </summary>
    </result>
    <result score="0.30297065">...</result>
    <result score="0.28671822">...</result>
    <result score="0.45699677">...</result>
    <result score="0.156553">...</result>
    <result score="0.6733877">...</result>
    <result score="0.40768817">...</result>
    <result score="1.0">...</result>
</searchResults>

Activate the checkpoint mode.
Use savedsearch/update with checkpointTime and checkpointActive parameters to store the last date and time you ran the search and to activate the checkpoint, respectively. From the previous search, use the search endDate as the checkpointTime.

Request
```
https://secure.newsedge.com/opensapi/20/savedsearch/update?session=935DA0B364E9E130F0EC3827FC3CCC9C&search=13822&checkpointTime=20160518T104125-0400&checkpointActive=TRUE
```
Response
```
<opens-api>
  <status>OK</status>
</opens-api>
        
```

Using Checkpoint Mode.

Back to Example

This section represents a loop of repeated steps to run a series of search requests, where each news search only retrieves the latest results since the last time the search was run. This set of steps assumes you first executed the previous set of steps, Initializing Checkpoint Mode, and have saved a checkpointTime.

Look-up the checkpointTime saved to a search.

Use savedsearch/list to find the saved search id and then use savedsearch/info to get the checkpoint time, cp_time attribute, for the saved search.

Request

https://secure.newsedge.com/opensapi/20/savedsearch/info?session=935DA0B364E9E130F0EC3827FC3CCC9C&search=13822

Response

<opens-api>
  <status>OK</status>
  <savedsearch ss="13822" owner="API User" level="PERSONAL" name="Weekly Pfizer Report" permission="WRITE" search="(([COM:/acorn=4101678755] AND [ss:13819] NOT [ss:13821]))&summary=1&sortBy=receivedate&dedup=1&cluster=1&searchDate=past7days" createdBy="API User" modifiedBy="" modifiedOn="20160319T115007-0400" cp_time="20160518T104125-0400" cp_active="TRUE"/>
</opens-api>

Search for results using checkpointTime.

Use the cp_time value from the previous step, as the value for startDate parameter in the news/search request.

Request

https://secure.newsedge.com/opensapi/20/news/search?session=935DA0B364E9E130F0EC3827FC3CCC9C&savedSearch=13822&startDate=20160518T104125-0400

Response

<searchResults searchKey="112130_20160520T115903922">
  <search startDate="20160518T104125-0400" endDate="20160520T120003-0400" resultsPerPage="20" stem="1" summary="1" metadata="0" taxonomy="0" entity="0" provider-code="0" minimum="0" cluster="1" dedup="1" refine="0" sorting="receiveDate" score="0" highlight="false" relevanceCutOff="85" busRelCutOff="70" includeProvDup="0" includeNRC="" filterLicensedPkg="" filterWebLinkedPkg="">
    <queryString>
      (([COM:/acorn=4101678755] AND [ss:13819] NOT [ss:13821]))
    </queryString>
   </search>
   <highlightTerms str="comHighlight=%2Facorn%3D4101678755&indCodeHighlight=ii%2Fhcare.pharma&subCodeHighlight=is%2Fhaw.clinical,is%2Fhaw.drugappr">
    <highlight/>
    <comCodeHighlight/>
    <comHighlight>/acorn=4101678755</comHighlight>
    <peoCodeHighlight/>
    <geoCodeHighlight/>
    <indCodeHighlight>ii/hcare.pharma</indCodeHighlight>
    <subCodeHighlight>is/haw.clinical,is/haw.drugappr</subCodeHighlight>
   </highlightTerms>
   <pageInfo>
    <totalResults>0</totalResults>
    <totalPages>0</totalPages>
    <resultsPage>0</resultsPage>
    <numberResults>0</numberResults>
    <topResult>0</topResult>
    <bottomResult>0</bottomResult>
   </pageInfo>
   <results status="true"/>
</searchResults>

Reset the checkpointTime.

Immediately after running the search, reset the checkpointTime parameter in savedsearch/update using the endDate attribute from the search element.

Request

https://secure.newsedge.com/opensapi/20/savedsearch/update?session=935DA0B364E9E130F0EC3827FC3CCC9C&search=13822&checkpointTime=20160520T120003-0400

Response

<opens-api>
  <status>OK</status>
</opens-api>

Repeat the previous steps as needed.
See the next example for how to deactivate the checkpoint mode.

Deactivating Checkpoint Mode

Back to Example

Reset the checkpointActive parameter.

To deactivate the checkpoint mode, use a value of FALSE for the checkpointActive parameter of savedsearch/update.

Request

https://secure.newsedge.com/opensapi/20/savedsearch/update?session=935DA0B364E9E130F0EC3827FC3CCC9C&search=13822&checkpointActive=FALSE

Response

<opens-api>
  <status>OK</status>
</opens-api>

savedsearch/create - Save a search

Save a search so it can be easily reused and repeated in news/search and other APIs. See also api/info where noun=savedsearch and verb=create. APIs that use saved searches include news/search, alert/create, and rss/get.

Parameter descriptions are divided into three groups:
1. Required Parameters
2. Optional Save Parameters. These are options related to the saved search.
3. Optional Search Parameters. These options each create a name-value pair that is concatenated to the query string to modify the search. These are equivalent to the optional parameters of a news/search.

Example

https://secure.newsedge.com/opensapi/20/savedsearch/create?session=<<user-token>>&name=<<search-name>>&query=(<<query-string>>)[&parameter=value][& . . . ]

Required Parameters

Parameter	Values	Description
name		A name for the saved search that provides a human-readable way to identify or categorize it. Note that a search ID will be created to uniquely identify the saved search.
query		A string of one or more search terms and other query formatting. For complete details of query string formats, see the Query Formats.
session		The ID of the OPENS API session. Use the user-token value returned from session/login.

Optional Parameters

Parameter	Values	Description
json	Default:0 0,1,2	The json parameter controls the format of the return data. If the parameter is not provided, the data is returned in XML format. 0 - Return data in XML format. 1 - Return data in compact JSON format. If the caller is planning on using JSON in production, this value should be used. 2 - Return data in expanded JSON format. This parameter value sets the return data to be in a more human-readable JSON form.

Optional Save Parameters

Parameter	Values	Description
checkpointActive	Default:FALSE TRUE, FALSE	The checkpointActive parameter in combination with the checkpointTime parameter provide the option to use a different search start date and time than the saved search normal settings. These values are case-sensitive. FALSE - The search will behave normally, i.e. use dates set with the searchDate parameter or the startDate and endDate parameters. TRUE - The search will use the value of the checkpointTime parameter for the start date and time.
checkpointTime	YYYYMMDDTHHMMSS-ZZZZ	Sets the date and time the search will start if the parameter checkpointActive=TRUE. Use the checkpointTime parameter in combination with the checkpointActive parameter.
level	Default:PERSONAL PERSONAL, GROUP, ACCOUNT	Sets the authorization level for the saved search. These values are case-sensitive. PERSONAL - Sets the saved search to be the user's personal search. Only the user can update, see, and use it. GROUP - Sets the saved search to the group level. Only users with group or account manager authorization can set this level and update the saved search. Users who are members of the group can see and use the search. ACCOUNT - Sets the saved search to the account level, which is the most restrictive authorization. Only users with account manager authorization can set this level and update the saved search. Users who are members of the same account can see and use the search.

Parameter

Values

Description

checkpointActive

Default:FALSE
TRUE, FALSE

The checkpointActive parameter in combination with the checkpointTime parameter provide the option to use a different search start date and time than the saved search normal settings. These values are case-sensitive.

FALSE - The search will behave normally, i.e. use dates set with the searchDate parameter or the startDate and endDate parameters.

TRUE - The search will use the value of the checkpointTime parameter for the start date and time.

checkpointTime

YYYYMMDDTHHMMSS-ZZZZ

Sets the date and time the search will start if the parameter checkpointActive=TRUE. Use the checkpointTime parameter in combination with the checkpointActive parameter.

level

Default:PERSONAL
PERSONAL, GROUP, ACCOUNT

Sets the authorization level for the saved search. These values are case-sensitive.

PERSONAL - Sets the saved search to be the user's personal search. Only the user can update, see, and use it.

GROUP - Sets the saved search to the group level. Only users with group or account manager authorization can set this level and update the saved search. Users who are members of the group can see and use the search.

ACCOUNT - Sets the saved search to the account level, which is the most restrictive authorization. Only users with account manager authorization can set this level and update the saved search. Users who are members of the same account can see and use the search.

Optional Search Parameters

Parameter	Values	Description
addlQuery		A description of addlQuery is found here .
busRelCutOff	Default:0 0-99	Use to override the default business relevance threshold value when executing the saved search with news/search. A description of busRelCutOff is found here .
cluster	Default:1 0,1	Use to set the cluster setting for the saved search. A description of cluster is found here .
dedup	Default:1 0,1	Use to set the remove duplicates setting for the saved search. A description of dedup is found here .
endDate	YYYY, YYMM, YYYYMMDD, YYYYMMDDTHHMMSS-ZZZZ	Use to save a defined end date for the saved search. See more details and a description of endDate here .
filterLicensedPkg	CS-Essentials, CS-Core, CS-Pro, CS-Extended, NONE	Specify the licensed content set included in the news/search results returned for the saved search. A description of filterLicensedPkg is found here .
filterWebLinkedPkg	WL-Essentials, WL-Core, WL-Pro, WL-Extended, NONE	Specify the WebLinked content set included in the news/search results returned for the saved search. A description of filterWebLinkedPkg is found here .
highlight	Default:false 0,false, 1,true	Set whether the search terms will be highlighted in the saved search results. A description of highlight is found here .
includeNRC	Default:Exclude NRC results All, NRC-code	Specify if stories coded as Non-Relevant Content are included in saved search results. A description of includeNRC is found here .
includeProvDup	Default:0 0, 1	Specify if stories marked as provider duplicates are included with the saved search results. A description of includeProvDup is found here .
metadata	0, 1	Set if the saved search results will include metadata elements. A description of metadata is found here .
minimum	Default:0 0, 1	Set elements returned with results of saved search. A description of minimum is found here .
relevanceCutOff	Default:0 0-99	Set the relevance cutoff threshold for the saved search. A description of relevanceCutOff is found here .
resultsPerPage	Default:20 1-210	Set the number of results returned in a news/search call. A description of resultsPerPage is found here .
searchDate	Default:today all, today, past2days, past7days, past14days, past21days, past30days, past60days, past90days, past6months, past1year, past2years, past3years, past4years, past5years, past6years, past7years, past8years, past9years, past10years, past11years, past12years.	Set a defined date range for the saved search. See more details and a description of searchDate here .
sort	Default:receivedate receivedate, publicationdate, relevance	Set the sort order for returned results. A description of sort is found here .
startDate	YYYY, YYMM, YYYYMMDD, YYYYMMDDTHHMMSS-ZZZZ	Set a start date for the saved search. See more details and a description of startDate here .
stem	Default:1 0, 1	Set whether the saved search query terms will be stemmed or not. A description of stem is found here .
summary	Default:1 0, 1	Set whether the saved search results will include story summaries. A description of summary is found here .

Returned Results

The results returned are an opens-api element containing status and savedsearch child elements.

opens-api

Name	Values	Description
status	OK, INVALID CPACTIVE, INVALID CPTIME, INVALID LEVEL, INVALID NAME, ERROR	The status of the request. OK - The request completed successfully. INVALID CPACTIVE - The checkpointActive parameter value is invalid. INVALID CPTIME - The checkpointTime parameter value is invalid. See the Parameter Date Format. INVALID LEVEL - The level parameter value is invalid. INVALID NAME - The name parameter is missing. ERROR - An error has occurred. Review api/info for parameter list.
savedsearch		The savedsearch element contains the following attributes: ss - The saved search unique ID. Use this value to identify the saved search in other API calls. name - The name for the saved search. permission - The current user's access permission for the saved search. Values include: WRITE - The user has permission to use the search as well as update, or delete it. READ - The user has permission to only use the search. Another user with the proper group or account authorization can update or delete it. OPAQUE - The user has permission to only use the search. Only an Acquire Media administrator can update or delete the search. search - A string representing the search, concatenated the following parameters: The query parameter value. The parameters with default settings listed as name-value pairs. Any additional search parameters included in the request listed as name-value pairs.

Name

Values

Description

status

OK, INVALID CPACTIVE, INVALID CPTIME, INVALID LEVEL, INVALID NAME, ERROR

The status of the request.

OK - The request completed successfully.

INVALID CPACTIVE - The checkpointActive parameter value is invalid.

INVALID CPTIME - The checkpointTime parameter value is invalid. See the Parameter Date Format.

INVALID LEVEL - The level parameter value is invalid.

INVALID NAME - The name parameter is missing.

ERROR - An error has occurred. Review api/info for parameter list.

savedsearch

The savedsearch element contains the following attributes:

ss - The saved search unique ID. Use this value to identify the saved search in other API calls.

name - The name for the saved search.

permission - The current user's access permission for the saved search. Values include:

WRITE - The user has permission to use the search as well as update, or delete it.

READ - The user has permission to only use the search. Another user with the proper group or account authorization can update or delete it.

OPAQUE - The user has permission to only use the search. Only an Acquire Media administrator can update or delete the search.

search - A string representing the search, concatenated the following parameters:

The query parameter value.

The parameters with default settings listed as name-value pairs.

Any additional search parameters included in the request listed as name-value pairs.

savedsearch/list - Get the list of saved searches

Use savedsearch/list to display a list of saved searches sorted alphabetically by name. Each saved search includes an ss attribute representing the saved search ID. Use the ss value in savedsearch/info to get all details about a specific saved search. See also api/info where noun= savedsearch and verb=list and savedsearch/info.

Example

https://secure.newsedge.com/opensapi/20/savedsearch/list?session=<<user-token>>[&level=level-value]

Required Parameters

Parameter	Values	Description
session		The ID of the OPENS API session. Use the user-token value returned from the session/login request.

Optional Parameters

Parameter

Values

Description

json

Default:0
0,1,2

The json parameter controls the format of the return data. If the parameter is not provided, the data is returned in XML format.

0 - Return data in XML format.
1 - Return data in compact JSON format. If the caller is planning on using JSON in production, this value should be used.
2 - Return data in expanded JSON format. This parameter value sets the return data to be in a more human-readable JSON form.

level

PERSONAL, GROUP, ACCOUNT, SYSTEM

Filter the list of saved searches by authorization levels. The values indicate who can update or delete the saved search:

PERSONAL - Only the current user.

GROUP - Only users with group administrator role.

ACCOUNT - Only users with account administrator role.

SYSTEM - Only an Acquire Media administrator.

Returned Results

The results returned are an opens-api element with a list of savedsearch elements.

opens-api

Name	Values	Description
savedsearches		A child element of opens-api containing a status child element and zero or more savedsearch child elements. The savedsearch child elements are sorted first alphabetically by name and then by ss ID.
status	OK, ERROR	The status of the request. OK - The request completed successfully. ERROR - An error has occurred. Review api/info for parameter list.
savedsearch		Each savedsearch element contains the following attributes: ss - The saved search ID. owner - The user who owns the saved search. For Personal saved searches, the owner is the current user. For Group level saved searches, the owner is the group name. For Account level saved searches, the owner is the account name. For System level saved searches, the owner is NewsEdge.com. level - The level of authorization for modifying the saved search. Values include PERSONAL, GROUP, ACCOUNT, or SYSTEM. name - The name for the saved search. permission - A value of WRITE means the user can use and modify the saved search. Values of READ or OPAQUE mean the user can only use the saved search but cannot modify it. lastModified - The time that this search was last change in ISO 8601 format YYYYMMDDTHHMMSS-ZZZZ. For more details about these attributes, see savedsearch/info.

Name

Values

Description

savedsearches

A child element of opens-api containing a status child element and zero or more savedsearch child elements. The savedsearch child elements are sorted first alphabetically by name and then by ss ID.

status

OK, ERROR

The status of the request.

OK - The request completed successfully.

ERROR - An error has occurred. Review api/info for parameter list.

savedsearch

Each savedsearch element contains the following attributes:

ss - The saved search ID.

owner - The user who owns the saved search. For Personal saved searches, the owner is the current user. For Group level saved searches, the owner is the group name. For Account level saved searches, the owner is the account name. For System level saved searches, the owner is NewsEdge.com.

level - The level of authorization for modifying the saved search. Values include PERSONAL, GROUP, ACCOUNT, or SYSTEM.

name - The name for the saved search.

permission - A value of WRITE means the user can use and modify the saved search. Values of READ or OPAQUE mean the user can only use the saved search but cannot modify it.

lastModified - The time that this search was last change in ISO 8601 format YYYYMMDDTHHMMSS-ZZZZ.

For more details about these attributes, see savedsearch/info.

savedsearch/info - Get information about a saved search

Use savedsearch/info to get details about a saved search such as the search query string and other settings. See also api/info where noun= savedsearch and verb=info and savedsearch/list.

Example

https://secure.newsedge.com/opensapi/20/savedsearch/info?session=<<user-token>>&search=<<ss-ID>>

Required Parameters

Parameter	Values	Description
search		A saved search identifier. Use the ss attribute value from the original savedsearch/create call or a savedsearch/list call.
session		The ID of the OPENS API session. Use the user-token value returned from the session/login request.

Optional Parameters

Parameter	Values	Description
json	Default:0 0,1,2	The json parameter controls the format of the return data. If the parameter is not provided, the data is returned in XML format. 0 - Return data in XML format. 1 - Return data in compact JSON format. If the caller is planning on using JSON in production, this value should be used. 2 - Return data in expanded JSON format. This parameter value sets the return data to be in a more human-readable JSON form.

Returned Results

Returned results are an opens-api element containing status and savedsearch child elements.

opens-api

Name	Values	Description
status	OK, INVALID SEARCHID, ERROR	The status of the request. OK - The request completed successfully. INVALID SEARCHID -The search ID is missing or invalid. Include the search parameter in the call. Use savedsearch/list to get a valid ss attribute value. ERROR - An error has occurred. Review api/info for parameter list.
savedsearch		The following attributes are included: ss - The saved search ID. owner - The user who owns the saved search. For Personal saved searches, the owner is the current user. For Group level saved searches, the owner is the group name. For Account level saved searches, the owner is the account name. For System level saved searches, the owner is NewsEdge.com. level - The level of authorization to change the saved search. Values include: PERSONAL - Only the current user can update or delete the saved search. GROUP - Only users with group administrator role can update or delete the saved search. ACCOUNT - Only users with account administrator role can update or delete the saved search. SYSTEM - Only an Acquire Media administrator can update or delete the search. name - The name for the saved search. permission - The access permission the current user has to use the saved search. Values include: WRITE - The user has permission to use the search as well as update or delete it. READ - The user has permission to only use the search. Another user with the proper group or account authorization can update or delete it. OPAQUE - The user has permission to only use the search. Only an Acquire Media administrator can update or delete the search. search - The search query string and search parameter settings concatenated as name-value pairs. createdBy - The user who created the saved search. modifiedBy - The user who last modified the saved search using savedsearch/update. modifiedOn - The date and time the saved search was last modified. cp_time - The date and time saved using parameter checkpointTime. cp_active - Use to track if the checkpoint is active or inactive. Values include: FALSE - Do not use the checkpointTime value as the next news/search startDate. TRUE - Use the checkpointTime value as the next news/search startDate.

Name

Values

Description

status

OK, INVALID SEARCHID, ERROR

The status of the request.

OK - The request completed successfully.

INVALID SEARCHID -The search ID is missing or invalid. Include the search parameter in the call. Use savedsearch/list to get a valid ss attribute value.

ERROR - An error has occurred. Review api/info for parameter list.

savedsearch

The following attributes are included:

ss - The saved search ID.

level - The level of authorization to change the saved search. Values include:
PERSONAL - Only the current user can update or delete the saved search.
GROUP - Only users with group administrator role can update or delete the saved search.
ACCOUNT - Only users with account administrator role can update or delete the saved search.
SYSTEM - Only an Acquire Media administrator can update or delete the search.

name - The name for the saved search.

permission - The access permission the current user has to use the saved search. Values include:
WRITE - The user has permission to use the search as well as update or delete it.
READ - The user has permission to only use the search. Another user with the proper group or account authorization can update or delete it.
OPAQUE - The user has permission to only use the search. Only an Acquire Media administrator can update or delete the search.

search - The search query string and search parameter settings concatenated as name-value pairs.

createdBy - The user who created the saved search.

modifiedBy - The user who last modified the saved search using savedsearch/update.

modifiedOn - The date and time the saved search was last modified.

cp_time - The date and time saved using parameter checkpointTime.

cp_active - Use to track if the checkpoint is active or inactive. Values include:
FALSE - Do not use the checkpointTime value as the next news/search startDate.
TRUE - Use the checkpointTime value as the next news/search startDate.

savedsearch/update - Update a saved search

Use savedsearch/update to update an existing saved search. See also api/info where noun=savedsearch and verb=update and savedsearch/list.

As with savedsearch/create, the parameter descriptions are divided into three groups:
1. Required Parameters
2. Optional Save Parameters. These are options related to the saved search.
3. Optional Search Parameters. These options each create a name-value pair that is concatenated to the query string to modify the search. These are equivalent to the optional parameters of a news/search.

Example

https://secure.newsedge.com/opensapi/20/savedsearch/update?session=<<user-token>>&search=<<ss-ID>>[&parameter=value][& . . .]

Required Parameters

Parameter	Values	Description
search		A saved search identifier. Use the ss attribute value from the original savedsearch/create call or a savedsearch/list call.
session		The ID of the OPENS API session. Use the user-token value returned from the session/login request.

Optional Parameters

Parameter	Values	Description
json	Default:0 0,1,2	The json parameter controls the format of the return data. If the parameter is not provided, the data is returned in XML format. 0 - Return data in XML format. 1 - Return data in compact JSON format. If the caller is planning on using JSON in production, this value should be used. 2 - Return data in expanded JSON format. This parameter value sets the return data to be in a more human-readable JSON form.

Optional Save Parameters

Parameter	Values	Description
checkpointActive	TRUE, FALSE	Reset the checkpoint state. The values are case-sensitive. A description of checkpointActive is found here .
checkpointTime	YYYYMMDDTHHMMSS-ZZZZ	Modify the date and time set as checkpointTime. A description of checkpointTime is found here .
level	PERSONAL, GROUP, ACCOUNT	Reset the authorization level for the saved search. The values are case-sensitive. A description of level is found here .
name		Modify the saved search name.

Optional Search Parameters

Parameter	Values	Description
addlQuery		Use to append or modify additional query terms. A description of addlQuery is found here .
busRelCutOff	0-99	Change the business relevance threshold to use with the saved search. A description of busRelCutOff is found here .
cluster	0, 1	Modify the cluster setting for the saved search, to group or not group similar stories in the returned results of news/search. A description of cluster is found here .
dedup	0, 1	Modify the remove duplicates setting for the saved search, to include or remove duplicates in the returned results of news/search. A description of dedup is found here .
endDate	YYYY, YYMM, YYYYMMDD, YYYYMMDDTHHMMSS-ZZZZ	Modify the end date used with the saved search. See more details and a description of endDate here .
filterLicensedPkg	CS-Essentials, CS-Core, CS-Pro, CS-Extended, NONE	Change the licensed content set included in the news/search results returned for the saved search. A description of filterLicensedPkg is found here .
filterWebLinkedPkg	WL-Essentials, WL-Core, WL-Pro, WL-Extended, NONE	Change the WebLinked content set included in the news/search results returned for the saved search. A description of filterWebLinkedPkg is found here .
highlight	0,false, 1,true	Reset whether the search terms will be highlighted in the saved search results. A description of highlight is found here .
includeNRC	All, NRC-code	Reset if stories coded as Non-Relevant Content are included in saved search results. A description of includeNRC is found here .
includeProvDup	0, 1	Reset if stories marked as provider duplicates are included with the saved search results. A description of includeProvDup is found here .
metadata	0, 1	Reset if the saved search results will include metadata elements. A description of metadata is found here .
query		edit the string of one or more search terms and other query formatting in the saved search. For complete details of query string formats, see the Query Formats document .
relevanceCutOff	0-99	Reset the relevance cutoff threshold for the saved search. A description of relevanceCutOff is found here .
resultsPerPage	1 - 210	Set the number of results returned in a news/search call. A description of resultsPerPage is found here .
searchDate	all, today, past2days, past7days, past14days, past21days, past30days, past60days, past90days, past6months, past1year, past2years, past3years, past4years, past5years, past6years, past7years, past8years, past9years, past10years, past11years, past12years.	Modify the search date range for the saved search. See more details and a description of searchDate here .
sort	receiveDate, publicationDate, relevance	Reset the order of the returned results. A description of sort is found here .
startDate	YYYY, YYMM, YYYYMMDD, YYYYMMDDTHHMMSS-ZZZZ	Modify the start date for the saved search. See more details and a description of startDate here .
stem	0, 1	Reset whether the saved search query terms will be stemmed or not. A description of stem is found here .
summary	0, 1	Reset whether the saved search results will include story summaries. A description of summary is found here .

Returned Results

Returned results are an opens-api element containing a status sub-element.

opens-api

Name	Values	Description
status	OK, INVALID SEARCHID, ERROR	The status of the request. OK - The request completed successfully. INVALID SEARCHID -The search ID is missing or invalid. Include the search parameter in the call. Use savedsearch/list to get a valid ss attribute value. ERROR - An error has occurred. Review api/info for parameter list.

Name

Values

Description

status

OK, INVALID SEARCHID, ERROR

The status of the request.

OK - The request completed successfully.

INVALID SEARCHID -The search ID is missing or invalid. Include the search parameter in the call. Use savedsearch/list to get a valid ss attribute value.

ERROR - An error has occurred. Review api/info for parameter list.

savedsearch/delete - Delete a saved search

Use savedsearch/delete to delete an existing saved search. See also api/info where noun= savedsearch and verb=delete and savedsearch/list.

Example

https://secure.newsedge.com/opensapi/20/savedsearch/delete?session=<<user-token>>&search=<<ss-ID>>

Required Parameters

Parameter	Values	Description
search		A saved search identifier. Use the ss attribute value from the original savedsearch/create call or a savedsearch/list call.
session		The ID of the OPENS API session. Use the user-token value returned from the session/login request.

Optional Parameters

Parameter	Values	Description
json	Default:0 0,1,2	The json parameter controls the format of the return data. If the parameter is not provided, the data is returned in XML format. 0 - Return data in XML format. 1 - Return data in compact JSON format. If the caller is planning on using JSON in production, this value should be used. 2 - Return data in expanded JSON format. This parameter value sets the return data to be in a more human-readable JSON form.

Returned Results

Returned results are an opens-api element containing a status sub-element.

opens-api

Name	Values	Description
status	OK, INVALID SEARCHID, ERROR	The status of the request. OK - The request completed successfully. INVALID SEARCHID -The search ID is missing or invalid. Include the search parameter in the call. Use savedsearch/list to get a valid ss attribute value. ERROR - An error has occurred. Review api/info for parameter list.

Name

Values

Description

status

OK, INVALID SEARCHID, ERROR

The status of the request.

OK - The request completed successfully.

INVALID SEARCHID -The search ID is missing or invalid. Include the search parameter in the call. Use savedsearch/list to get a valid ss attribute value.

ERROR - An error has occurred. Review api/info for parameter list.

API Definition

Saving and Reusing Searches

savedsearch/create - Save a search

Example

Required Parameters

Optional Parameters

Optional Save Parameters

Optional Search Parameters

Returned Results

opens-api

savedsearch/list - Get the list of saved searches

Example

Required Parameters

Optional Parameters

Returned Results

opens-api

savedsearch/info - Get information about a saved search

Example

Required Parameters

Optional Parameters

Returned Results

opens-api

savedsearch/update - Update a saved search

Example

Required Parameters

Optional Parameters

Optional Save Parameters

Optional Search Parameters

Returned Results

opens-api

savedsearch/delete - Delete a saved search

Example

Required Parameters

Optional Parameters

Returned Results

opens-api