# <CDF Name> (Feed)
 
# Versioning
 
* Current integration version: `<Version String>`
* Compatible with ThreatQ versions >= `<TQ Version String>`
* Compatible with <third party application> => '<third party version>'
<Make note of the type of third-party deployment we support on-prem, cloud etc>
 
# Overview
 
<Some Description Block>
 
The integration provides the following feeds:
* <Feed Name> - <short statement about the data that is ingested from this feed>
 
The integration ingests the following system objects:
* <object>
 
### Data Summary
 
<Objects included in feeds>
 
<Supporting context>
 
## Technical Data
 
### Prerequisites
 
<Some Description Block. Used to relate setup steps for the Integration and/or the Integration's credentials>
 
# ThreatQ Mapping
 
## <Feed Name> (should be a section for each feed in the YAML definition)
<Description Block describing the type / structure of data being returned>
`<HTTP Verb, eg GET> https://www.provider.xyz/endpoint`
 
Sample Response:
 
 
```
    <Data Example from the Vendor>
```
 
ThreatQ provides the following default mapping for this feed:
 
| Feed Data Path | ThreatQ Entity | ThreatQ Object Type or Attribute Key | Published Date | Examples | Notes
|----------------|----------------|--------------------------------------|----------------|----------|------
| <Data Path> | <TQ Entity> | <Type or Key> | <Data Path to Published Date> | <Some Example> | <Some Note>
| <Data Path> | <TQ Entity> | <Type or Key> | <Data Path to Published Date> | <Some Example> | <Some Note>
 
### <An Auxiliary Mapping Table Name>:
 
| <Provider Field> Value | <ThreatQ Field> Value
|------------------------|----------------------
| <Provider Value> | <ThreatQ Value>
| <Provider Value> | <ThreatQ Value>
 
 
# Average Feed Run
Average Feed Run results for <Feed Name>:
 
| Metric | Result
|--------|-------
| Run Time | <Average FeedRun Time>
| Indicators | <Indicator Count>
| Indicator Attributes | <Indicator Attribute Count>
| Adversaries | <Adversary Count>
| Adversary Attributes | <Adversary Attribute Count>
| SomeCustomObject | <Custom Object Count>
| SomeCustomObject Attributes | <Custom Object Attribute Count>
 
**Note:** Object counts and Feed runtime are supplied as generalities only - objects returned by a provider can differ
based on credential configurations and Feed runtime may vary based on system resources and load.
 
# Installation Guide
 
The feed can be installed via the My Integrations page in the ThreatQ UI.
 
# ThreatQ UI Configuration
 
This feed is installed under the __<Feed Category>__ category.
 
This feed provides the following configuration parameters:
 
* __<User Field Name>__: <Description of User Field's behavior>
* __<User Field Name>__: <Description of User Field's behavior>
 
# Known Issues/Limitations
 
<Any known issues - if none mark as N/A>
 
# Change Log
 
* Version X.Y.Z
  * Some note on the changes
* Version 1.0.0
  * Initial release