User Tools

Site Tools


api

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Last revisionBoth sides next revision
api [2022/01/11 09:17] – [Detailed Documentation] lucysecurityapi [2022/03/05 18:11] lucysecurity
Line 31: Line 31:
 server expects when you are creating a new campaign. The only difference is links - when you are posting/putting something to API, the server does not expect any links (and ignores them if they are present in request). The links are only used for exposing relations in GET requests. For specifying relations with other existing objects in system, please use integer IDs. server expects when you are creating a new campaign. The only difference is links - when you are posting/putting something to API, the server does not expect any links (and ignores them if they are present in request). The links are only used for exposing relations in GET requests. For specifying relations with other existing objects in system, please use integer IDs.
  
 +===== API Records Return Limit =====
  
-===== Example Usage =====+All endpoints returning a list of Resources, by default, can return only 100 records. If necessary, this can be changed using request parameters LIMIT and OFFSET.\\ 
 + 
 +The maximum LIMIT is "1000". Any LIMIT values exceeding 1000 will return maximum of 1000 records.\\
  
-**WARNING!** 
-It's recommended to use "//limit//" GET parameter to specify the max number of entries to get.\\ 
-This might help to avoid situations when the amount of data would not be comprehensible by the system.\\ 
 Example:\\ Example:\\
   {GET /api/campaigns?sort=-created_at&offset=10&limit=10}   {GET /api/campaigns?sort=-created_at&offset=10&limit=10}
 +
 +===== Example Usage =====
  
 First you need to auth: First you need to auth:
api.txt · Last modified: 2022/03/05 18:12 by lucysecurity