{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/timestamped_exports/templates","auth":"required","results":{"codes":[{"status":200,"language":"json","code":"{\n  \"templates\": [\n    {\n      \"id\": \"99d4b597-500e-448c-ad71-902cdb282c23\",\n      \"title\": \"My Template\",\n      \"data_keys\": [\n        \"ssn\"\n      ],\n      \"upper_bound\": \"2016-04-15T07:19:58.018-07:00\",\n      \"lower_bound\": \"2016-04-05T07:19:58.017-07:00\",\n      \"busy\": false,\n      \"type\": \"last_7_days\",\n      \"number_of_days\": 7,\n      \"funnel_ids\": [\n        \"e28927a0-9715-4d48-85d4-f68ede650819\"\n      ]\n    }\n  ],\n  \"pagination\": {\n    \"first\": 1,\n    \"previous\": \"\",\n    \"current\": 1,\n    \"next\": \"\",\n    \"last\": 1\n  }\n}","name":""}]},"settings":"","examples":{"codes":[{"code":"curl -X GET -H 'X-ACCESS-TOKEN: secret-api-token' 'https://api.fountain.com/v2/timestamped_exports/templates'","language":"curl"},{"code":"https://www.onboardiq.com/api/v2/timestamped_exports/templates?api_token=secret-api-token","language":"text"}]},"method":"get","params":[{"name":"X-ACCESS-TOKEN","type":"string","default":"secret-api-token","desc":"Access Token","required":true,"in":"header","ref":"","_id":"60dd10e4479c220040718350"}]},"next":{"description":"","pages":[]},"title":"List Timestamped Export Templates","type":"endpoint","slug":"list-export-templates","excerpt":"","body":"# List Timestamped Export Templates\n\nLists all timestamped export templates in the account.\n\nTemplate data includes which data keys are used and which Openings (funnels) are reported, as well as the bounds.\n\nUse the page parameter to indicate the page for pagination, e.g. &page=2 to get to the 2nd page of the listing.\n\n# Response Schema\n\n*   templates\n    *   Required: no\n    *   Type: array\n    *   Items\n        *   Required: no\n        *   id\n            *   Required: no\n            *   Type: string\n            *   Example: \"99d4b597-500e-448c-ad71-902cdb282c23\"\n        *   title\n            *   Required: no\n            *   Type: string\n            *   Example: \"My Template\"\n        *   data_keys\n            *   Required: no\n            *   Type: array\n            *   Items\n                *   Required: no\n                *   Type: string\n                *   Example: \"ssn\"\n        *   upper_bound\n            *   Required: no\n            *   Type: string\n            *   Format: date-time\n            *   Example: \"2016-04-15T07:19:58.018-07:00\"\n        *   lower_bound\n            *   Required: no\n            *   Type: string\n            *   Format: date-time\n            *   Example: \"2016-04-05T07:19:58.017-07:00\"\n        *   busy\n             *  Required: no\n             *  Type: boolean\n             *  Example: false\n       *   type\n            *   Required: no\n            *   Type: string\n            *  Example: \"last_7_days\"\n        *   number_of_days\n            *  Required: no\n            *  Type: integer\n            *   Example: 7\n        *   funnel_ids\n            *   Required: no\n            *   Type: array\n            *   Items\n                *   Required: no\n                *   id\n                    *   Required: no\n                    *   Type: string\n                    *   Example: \"e28927a0-9715-4d48-85d4-f68ede650819\n*   pagination\n    *   Required: no\n    *   first\n        *   Required: no\n        *   Type: integer\n        *   Example: 1\n    *   previous\n        *   Required: no\n        *   Type: null\n        *   Example: \"\"\n    *   current\n        *   Required: no\n        *   Type: integer\n        *   Example: 1\n    *   next\n        *   Required: no\n        *   Type: null\n        *   Example: \"\"\n    *   last\n        *   Required: no\n        *   Type: integer\n        *   Example: 1","updates":[],"order":4,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"59de6011debd1200240f6924","user":"547504ed59fade080004cb8b","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Export Management","slug":"exports","order":8,"from_sync":false,"reference":false,"_id":"59de6011debd1200240f68f9","__v":0,"project":"59de6011debd1200240f68ec","version":"59de6011debd1200240f68ee","createdAt":"2016-05-24T19:12:00.251Z"},"version":{"version":"2.0","version_clean":"2.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["59de6011debd1200240f68fb","59de6011debd1200240f68fa","59de6011debd1200240f68fc","59de6011debd1200240f68f8","59de6011debd1200240f68f7","59de6011debd1200240f68f9","59de6011debd1200240f68fd","59de6011debd1200240f68fe","59de6011debd1200240f68ff","5a8bfb99f4146e00449cec47","5a8bfcf2e86f530012159bb2","5cd4c29c6ea1040056ec0f55"],"_id":"59de6011debd1200240f68ee","__v":3,"project":"59de6011debd1200240f68ec","createdAt":"2016-06-20T18:15:42.514Z","releaseDate":"2016-06-20T18:15:42.514Z"},"parentDoc":null,"__v":22,"project":"59de6011debd1200240f68ec","createdAt":"2016-06-20T18:29:06.520Z","githubsync":""}

getList Timestamped Export Templates


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Headers

X-ACCESS-TOKEN:
required
stringsecret-api-token
Access Token

Examples


Result Format


Documentation

# List Timestamped Export Templates Lists all timestamped export templates in the account. Template data includes which data keys are used and which Openings (funnels) are reported, as well as the bounds. Use the page parameter to indicate the page for pagination, e.g. &page=2 to get to the 2nd page of the listing. # Response Schema * templates * Required: no * Type: array * Items * Required: no * id * Required: no * Type: string * Example: "99d4b597-500e-448c-ad71-902cdb282c23" * title * Required: no * Type: string * Example: "My Template" * data_keys * Required: no * Type: array * Items * Required: no * Type: string * Example: "ssn" * upper_bound * Required: no * Type: string * Format: date-time * Example: "2016-04-15T07:19:58.018-07:00" * lower_bound * Required: no * Type: string * Format: date-time * Example: "2016-04-05T07:19:58.017-07:00" * busy * Required: no * Type: boolean * Example: false * type * Required: no * Type: string * Example: "last_7_days" * number_of_days * Required: no * Type: integer * Example: 7 * funnel_ids * Required: no * Type: array * Items * Required: no * id * Required: no * Type: string * Example: "e28927a0-9715-4d48-85d4-f68ede650819 * pagination * Required: no * first * Required: no * Type: integer * Example: 1 * previous * Required: no * Type: null * Example: "" * current * Required: no * Type: integer * Example: 1 * next * Required: no * Type: null * Example: "" * last * Required: no * Type: integer * Example: 1

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}